org.ehcache.config.CacheConfiguration Maven / Gradle / Ivy
/*
* Copyright Terracotta, Inc.
*
* Licensed 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.
*/
package org.ehcache.config;
import org.ehcache.Cache;
import org.ehcache.expiry.Expiry;
import org.ehcache.spi.service.ServiceConfiguration;
import java.util.Collection;
/**
* Represents the minimal read-only configuration for a Cache to be, or an already existing one
*
* @param the type of the keys used to access data within the cache
* @param the type of the values held within the cache
*
* @author Alex Snaps
*/
public interface CacheConfiguration {
/**
* Not sure whether this should be exposed on this interface really.
*
* @return unmodifiable collection of service configuration related to the cache
*/
Collection> getServiceConfigurations();
/**
* The type of the key for the cache.
*
* @return a non null value, where {@code Object.class} is the widest type
*/
Class getKeyType();
/**
* The type of the value held in the cache.
*
* @return a non null value, where {@code Object.class} is the widest type
*/
Class getValueType();
/**
* The {@link EvictionVeto} predicate function.
*
* Entries which pass this predicate must be ignored by the eviction process.
*
* @return the eviction veto predicate
*/
EvictionVeto getEvictionVeto();
/**
* The {@link ClassLoader} for this cache. This {@code ClassLoader} will be used to instantiate cache level services
* as well as deserializing cache entries when required.
*
* @return the cache {@code ClassLoader}
*/
ClassLoader getClassLoader();
/**
* Get the {@link Expiry expiration policy} instance for the {@link Cache}.
*
* @return the {@code Expiry} to configure
*/
Expiry getExpiry();
/**
* Get the {@link ResourcePools resource pools} the {@link Cache} can make use of.
*
* @return non {@code null} and non empty {@link ResourcePools}
*/
ResourcePools getResourcePools();
}