spring-cache-api/src/main/java/org/apache/archiva/redback/components/cache/factory/CacheCreator.java

package org.apache.archiva.redback.components.cache.factory;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.archiva.redback.components.cache.Cache;
import org.apache.archiva.redback.components.cache.CacheException;
import org.apache.archiva.redback.components.cache.CacheHints;

/**
 * CacheCreator - an interface for CacheCreators
 *
 * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
 *
 */
public interface CacheCreator
{
    /**
     * Create a Cache, initialize it, and return it.
     * 
     * @param cacheHint the cache hints to use.
     * @return the created cache.
     * @throws CacheException if there was a cache creation error.
     */
    public Cache createCache( CacheHints hints ) throws CacheException;
}