001package org.apache.commons.jcs.auxiliary;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.commons.jcs.auxiliary.AuxiliaryCacheFactory;
023
024/**
025 * Base class for auxiliary cache factories.
026 */
027public abstract class AbstractAuxiliaryCacheFactory
028    implements AuxiliaryCacheFactory
029{
030    /** The auxiliary name. The composite cache manager keeps this in a map, keyed by name. */
031    private String name = this.getClass().getSimpleName();
032
033    /**
034     * Initialize this factory
035     */
036    @Override
037    public void initialize()
038    {
039        // empty
040    }
041
042    /**
043     * Dispose of this factory, clean up shared resources
044     */
045    @Override
046    public void dispose()
047    {
048        // empty
049    }
050
051    /**
052     * Gets the name attribute of the DiskCacheFactory object
053     * <p>
054     * @return The name value
055     */
056    @Override
057    public String getName()
058    {
059        return this.name;
060    }
061
062    /**
063     * Sets the name attribute of the DiskCacheFactory object
064     * <p>
065     * @param name The new name value
066     */
067    @Override
068    public void setName( String name )
069    {
070        this.name = name;
071    }
072}