Index (cache2k API 1.0.0.CR3 API)

A B C D E F G H I K L M N O P R S T V W

A

add(ConfigurationSection) - Method in class org.cache2k.configuration.ConfigurationSectionContainer: Add a new configuration section to the container.
add(CustomizationSupplier<T>) - Method in interface org.cache2k.configuration.CustomizationCollection: Adds a customization to the collection.
add(CustomizationSupplier<T>) - Method in class org.cache2k.configuration.DefaultCustomizationCollection: Adds a customization to the collection.
addAll(Collection<? extends CustomizationSupplier<T>>) - Method in interface org.cache2k.configuration.CustomizationCollection: Adds all customizations to the collection.
addAll(Collection<? extends CustomizationSupplier<T>>) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
addAsyncListener(CacheEntryOperationListener<K, V>) - Method in class org.cache2k.Cache2kBuilder: A set of listeners.
addListener(CacheEntryOperationListener<K, V>) - Method in class org.cache2k.Cache2kBuilder: Add a listener.
AdvancedCacheLoader<K,V> - Class in org.cache2k.integration: Retrieves or generates a value to load into the cache.
AdvancedCacheLoader() - Constructor for class org.cache2k.integration.AdvancedCacheLoader
AdvancedKeyValueSource<K,V> - Interface in org.cache2k: KeyValueSource with bulk get and prefetching.
asMap() - Method in interface org.cache2k.Cache: Returns a map interface for operating with this cache.
asyncListenerExecutor(Executor) - Method in class org.cache2k.Cache2kBuilder: Executor for asynchronous listeners.

B

boostConcurrency(boolean) - Method in class org.cache2k.Cache2kBuilder: When true, optimize for high core counts and applications that do lots of mutations in the cache.
build() - Method in class org.cache2k.Cache2kBuilder: Builds a cache with the specified configuration parameters.
buildConfigurationSection() - Method in interface org.cache2k.configuration.ConfigurationSectionBuilder

C

Cache<K,V> - Interface in org.cache2k: A cache is similar to a map or a key value store, allowing to retrieve and update values which are associated to keys.
Cache2kBuilder<K,V> - Class in org.cache2k: Builder to create a Cache instance.
Cache2kBuilder() - Constructor for class org.cache2k.Cache2kBuilder: Constructor to override for the usage pattern:
Cache2kConfiguration<K,V> - Class in org.cache2k.configuration: Configuration for a cache2k cache.
Cache2kConfiguration() - Constructor for class org.cache2k.configuration.Cache2kConfiguration
Cache2kCoreProvider - Interface in org.cache2k.spi: Interface to the cache2k implementation.
Cache2kExtensionProvider - Interface in org.cache2k.spi: Interface for a generic cache2k extension.
CacheEntry<K,V> - Interface in org.cache2k: Object representing a cache entry.
CacheEntryCreatedListener<K,V> - Interface in org.cache2k.event: A new entry is inserted into the cache, e.g.
CacheEntryExpiredListener<K,V> - Interface in org.cache2k.event: Listener called for an expired entry.
CacheEntryOperationListener<K,V> - Interface in org.cache2k.event: The root of all listeners that are called for an entry lifecycle and updates.
CacheEntryRemovedListener<K,V> - Interface in org.cache2k.event: Called when an entry was actively removed from the cache.
CacheEntryUpdatedListener<K,V> - Interface in org.cache2k.event: Fires in case a cache entry is mutated.
CacheException - Exception in org.cache2k: Base class of all cache exceptions.
CacheException() - Constructor for exception org.cache2k.CacheException
CacheException(String) - Constructor for exception org.cache2k.CacheException
CacheException(String, Throwable) - Constructor for exception org.cache2k.CacheException
CacheException(Throwable) - Constructor for exception org.cache2k.CacheException
CacheLoader<K,V> - Class in org.cache2k.integration: Retrieves or generates a value to load into the cache.
CacheLoader() - Constructor for class org.cache2k.integration.CacheLoader
CacheLoaderException - Exception in org.cache2k.integration: Exception to wrap a loader exception.
CacheLoaderException(String, Throwable) - Constructor for exception org.cache2k.integration.CacheLoaderException
CacheLoaderException(Throwable) - Constructor for exception org.cache2k.integration.CacheLoaderException
CacheManager - Class in org.cache2k: A cache manager holds a set of caches.
CacheManager() - Constructor for class org.cache2k.CacheManager
CacheOperationCompletionListener - Interface in org.cache2k: A listener implemented by the cache client to get notification about the completion of a load or prefetch operation.
CacheType<T> - Interface in org.cache2k.configuration: A data structure to retain all known type information from the key and value types, including generic parameters within the cache configuration.
CacheTypeCapture<T> - Class in org.cache2k.configuration: Helper class to capture generic types into a type descriptor.
CacheTypeCapture() - Constructor for class org.cache2k.configuration.CacheTypeCapture
CacheTypeCapture.OfArray - Class in org.cache2k.configuration: CacheType representing an array.
CacheTypeCapture.OfClass - Class in org.cache2k.configuration: CacheType representing a class.
CacheTypeCapture.OfGeneric - Class in org.cache2k.configuration: CacheType representing a generic type.
CacheWriter<K,V> - Class in org.cache2k.integration: Writer for write-through configurations.
CacheWriter() - Constructor for class org.cache2k.integration.CacheWriter
CacheWriterException - Exception in org.cache2k.integration: Wraps an exception caused by a writer.
CacheWriterException(Throwable) - Constructor for exception org.cache2k.integration.CacheWriterException
calculateExpiryTime(K, V, long, CacheEntry<K, V>) - Method in interface org.cache2k.expiry.ExpiryPolicy: Returns the time of expiry in milliseconds since epoch.
clear() - Method in interface org.cache2k.Cache: Clear the cache in a fast way, causing minimal disruption.
clear() - Method in class org.cache2k.CacheManager: Clear all currently active caches in this cache manager
clear() - Method in class org.cache2k.configuration.DefaultCustomizationCollection
clearAndClose() - Method in interface org.cache2k.Cache: This is currently identical to Cache.close().
close() - Method in interface org.cache2k.Cache: Free all resources and remove the cache from the CacheManager.
close(ClassLoader, String) - Static method in class org.cache2k.CacheManager: Close the named cache manager.
close() - Method in class org.cache2k.CacheManager: Free all resources from managed caches.
close() - Method in interface org.cache2k.KeyValueSource: Release all resources associated to this object.
close() - Method in interface org.cache2k.spi.Cache2kCoreProvider: Close all cache2k cache managers.
close(ClassLoader) - Method in interface org.cache2k.spi.Cache2kCoreProvider: Close all cache manager associated to this class loader.
close(ClassLoader, String) - Method in interface org.cache2k.spi.Cache2kCoreProvider: Close a specific cache manager by its name.
closeAll() - Static method in class org.cache2k.CacheManager: Close all cache managers.
closeAll(ClassLoader) - Static method in class org.cache2k.CacheManager: Close all cache manager associated with this class loader.
ConfigurationBean - Interface in org.cache2k.configuration: Marker for cache configuration beans.
ConfigurationSection - Interface in org.cache2k.configuration: Marker interface for additional configuration section beans.
ConfigurationSectionBuilder<T extends ConfigurationSection> - Interface in org.cache2k.configuration
ConfigurationSectionContainer - Class in org.cache2k.configuration: Container for configuration objects.
ConfigurationSectionContainer() - Constructor for class org.cache2k.configuration.ConfigurationSectionContainer
ConfigurationWithSections - Interface in org.cache2k.configuration: If the configuration bean has additional sub configuration beans, then it implements this interface.
contains(Object) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
containsAll(Collection<?>) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
containsAndRemove(K) - Method in interface org.cache2k.Cache: Removes the mapping for a key from the cache and returns true if it one was present.
containsKey(K) - Method in interface org.cache2k.Cache: Returns true, if there is a mapping for the specified key.
createCache(Cache2kConfiguration<K, V>) - Method in class org.cache2k.CacheManager: Create a new cache from the configuration.
createCache(CacheManager, Cache2kConfiguration<K, V>) - Method in interface org.cache2k.spi.Cache2kCoreProvider: Create a cache, apply external configuration before creating it.
CustomizationCollection<T> - Interface in org.cache2k.configuration: Collection of customizations.
CustomizationException - Exception in org.cache2k: Wraps an exception thrown from a cache customization such as the ExpiryPolicy or CacheLoader.
CustomizationException(String) - Constructor for exception org.cache2k.CustomizationException
CustomizationException(Throwable) - Constructor for exception org.cache2k.CustomizationException
CustomizationException(String, Throwable) - Constructor for exception org.cache2k.CustomizationException
CustomizationReferenceSupplier<T> - Class in org.cache2k.configuration: A reference to the customization to be used is set while building the cache.
CustomizationReferenceSupplier(T) - Constructor for class org.cache2k.configuration.CustomizationReferenceSupplier: Construct a customization factory that returns always the same object instance.
CustomizationSupplier<T> - Interface in org.cache2k.configuration: Supplies a cache customizations like ExpiryPolicy or CacheLoader.
CustomizationSupplierByClassName<T> - Class in org.cache2k.configuration: Creates a new instance of the customization based on the class name and the class loader in effect by the cache.
CustomizationSupplierByClassName() - Constructor for class org.cache2k.configuration.CustomizationSupplierByClassName: Default constructor for beans.
CustomizationSupplierByClassName(String) - Constructor for class org.cache2k.configuration.CustomizationSupplierByClassName: Construct a customization factory based on the class name.

D

DefaultCustomizationCollection<T> - Class in org.cache2k.configuration: Default implementation for a customization collection using a list.
DefaultCustomizationCollection() - Constructor for class org.cache2k.configuration.DefaultCustomizationCollection
delete(K) - Method in class org.cache2k.integration.CacheWriter: Called when a mapping is removed from the cache.
DESCRIPTOR_TO_STRING_PREFIX - Static variable in interface org.cache2k.configuration.CacheType: The used prefix for the toString() output.
disableLastModificationTime(boolean) - Method in class org.cache2k.Cache2kBuilder: Disable that the last modification time is available at CacheEntry.getLastModification().
disableStatistics(boolean) - Method in class org.cache2k.Cache2kBuilder: By default statistic gathering is enabled.

E

earliestTime(long, long, long) - Static method in class org.cache2k.expiry.Expiry: Helper to calculate the next expiry out of two expiry times that may be up next.
entries() - Method in interface org.cache2k.Cache: Iterate all entries in the cache.
entryCapacity(long) - Method in class org.cache2k.Cache2kBuilder: The maximum number of entries hold by the cache.
EntryProcessingException - Exception in org.cache2k.processor: Wrapped exception of an exception thrown during entry processing.
EntryProcessingException(Throwable) - Constructor for exception org.cache2k.processor.EntryProcessingException
EntryProcessingResult<R> - Interface in org.cache2k.processor: Result tuple for Cache.invokeAll().
EntryProcessor<K,V,R> - Interface in org.cache2k.processor: An invokable function to perform an atomic operation on a cache entry.
equals(Object) - Method in class org.cache2k.configuration.CacheTypeCapture
equals(Object) - Method in class org.cache2k.configuration.CacheTypeCapture.OfArray
equals(Object) - Method in class org.cache2k.configuration.CacheTypeCapture.OfClass
equals(Object) - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
equals(Object) - Method in class org.cache2k.configuration.CustomizationReferenceSupplier
equals(Object) - Method in class org.cache2k.configuration.CustomizationSupplierByClassName
eternal(boolean) - Method in class org.cache2k.Cache2kBuilder: When set to true, cached values do not expire by time.
ETERNAL - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: Return value signalling to keep the value forever in the cache, switching off expiry.
ExceptionInformation - Interface in org.cache2k.integration: Relevant information of load attempt that generated an exception.
exceptionPropagator(ExceptionPropagator<K>) - Method in class org.cache2k.Cache2kBuilder
ExceptionPropagator<K> - Interface in org.cache2k.integration: In read through mode exceptions are cached.
exists() - Method in interface org.cache2k.processor.MutableCacheEntry: True if a mapping exists in the cache, never invokes the loader / cache source.
expireAfterWrite(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder: Time duration after insert or updated an cache entry expires.
expireAt(K, long) - Method in interface org.cache2k.Cache: Updates an existing not expired mapping to expire at the given point in time.
Expiry - Class in org.cache2k.expiry: Utility methods and constants to use inside expire policy and friends.
Expiry() - Constructor for class org.cache2k.expiry.Expiry
EXPIRY_NOT_ETERNAL - Static variable in class org.cache2k.configuration.Cache2kConfiguration
expiryPolicy(ExpiryPolicy<K, V>) - Method in class org.cache2k.Cache2kBuilder: Set expiry policy to use.
ExpiryPolicy<K,V> - Interface in org.cache2k.expiry: A custom policy which allows to calculate a dynamic expiry time for an entry after an insert or update.
ExpiryTimeValues - Interface in org.cache2k.expiry: Expiry time values that have a special meaning.

F

forUnknownTypes() - Static method in class org.cache2k.Cache2kBuilder: Create a new cache builder for a cache that has no type restrictions or to set the type information later via the builder methods Cache2kBuilder.keyType or Cache2kBuilder.valueType.
FunctionalCacheLoader<K,V> - Interface in org.cache2k.integration: Functional cache loader interface to be used when only a single method is used.

G

get(K) - Method in interface org.cache2k.Cache: Returns a value associated with the given key.
get(K) - Method in interface org.cache2k.KeyValueSource: Returns a value associated with this key.
getActiveCaches() - Method in class org.cache2k.CacheManager: Returns all caches created in this cache manager instance.
getAdvancedLoader() - Method in class org.cache2k.configuration.Cache2kConfiguration
getAll(Iterable<? extends K>) - Method in interface org.cache2k.AdvancedKeyValueSource: Retrieves all values for the given keys.
getAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Retrieve values from the cache associated with the provided keys.
getAsyncListenerExecutor() - Method in class org.cache2k.configuration.Cache2kConfiguration
getAsyncListeners() - Method in class org.cache2k.configuration.Cache2kConfiguration: A set of listeners.
getBeanRepresentation() - Method in interface org.cache2k.configuration.CacheType: Return a serializable version of this type descriptor.
getBeanRepresentation() - Method in class org.cache2k.configuration.CacheTypeCapture
getCache(String) - Method in class org.cache2k.CacheManager: Return a known cache that must be created before via the Cache2kBuilder or CacheManager.createCache(Cache2kConfiguration)
getCacheExpiryTime() - Method in interface org.cache2k.expiry.ValueWithExpiryTime: Point in time in milliseconds since when the value should expire.
getCacheManager() - Method in interface org.cache2k.Cache: Return the cache manager for this cache instance.
getClassLoader() - Method in class org.cache2k.CacheManager: Class loader this manager is using to load additional classes, resources or configuration.
getClassName() - Method in class org.cache2k.configuration.CustomizationSupplierByClassName
getComponentType() - Method in interface org.cache2k.configuration.CacheType: The component type in case of an array
getComponentType() - Method in class org.cache2k.configuration.CacheTypeCapture
getComponentType() - Method in class org.cache2k.configuration.CacheTypeCapture.OfArray
getDefaultClassLoader() - Method in interface org.cache2k.spi.Cache2kCoreProvider: Default class loader, this is the class loader used to load the cache implementation.
getDefaultConfiguration(CacheManager) - Method in interface org.cache2k.spi.Cache2kCoreProvider: Return the effective default configuration for this manager.
getDefaultManagerName(ClassLoader) - Method in interface org.cache2k.spi.Cache2kCoreProvider
getDefaultName() - Static method in class org.cache2k.CacheManager: Name of the default cache manager, which is "default" by default.
getEntry(K) - Method in interface org.cache2k.Cache: Returns an entry that contains the cache value associated with the given key.
getEntryCapacity() - Method in class org.cache2k.configuration.Cache2kConfiguration
getException() - Method in interface org.cache2k.CacheEntry: The exception happened when the value was loaded and the exception could not be suppressed.
getException() - Method in interface org.cache2k.integration.ExceptionInformation: The original exception generated by the last recent loader call.
getException() - Method in interface org.cache2k.processor.EntryProcessingResult: Original exception of entry processing or null if no exception occurred.
getExceptionPropagator() - Method in class org.cache2k.configuration.Cache2kConfiguration
getExpireAfterWrite() - Method in class org.cache2k.configuration.Cache2kConfiguration
getExpireAfterWriteMillis() - Method in interface org.cache2k.integration.ResiliencePolicy.Context: Expiry duration after entry mutation.
getExpiryPolicy() - Method in class org.cache2k.configuration.Cache2kConfiguration
getInstance() - Static method in class org.cache2k.CacheManager: Get the default cache manager for the default class loader.
getInstance(ClassLoader) - Static method in class org.cache2k.CacheManager: Get the default cache manager for the specified class loader.
getInstance(String) - Static method in class org.cache2k.CacheManager: Retrieve a cache manager with the specified name.
getInstance(ClassLoader, String) - Static method in class org.cache2k.CacheManager: Retrieve a cache manager with the specified name using the specified classloader.
getKey() - Method in interface org.cache2k.CacheEntry: Key associated with this entry.
getKeyType() - Method in class org.cache2k.configuration.Cache2kConfiguration
getLastModification() - Method in interface org.cache2k.CacheEntry: Time in millis the entry was last modified.
getListeners() - Method in class org.cache2k.configuration.Cache2kConfiguration: A set of listeners.
getLoader() - Method in class org.cache2k.configuration.Cache2kConfiguration
getLoaderExecutor() - Method in class org.cache2k.configuration.Cache2kConfiguration
getLoaderThreadCount() - Method in class org.cache2k.configuration.Cache2kConfiguration
getLoadTime() - Method in interface org.cache2k.integration.ExceptionInformation: Start time of the load operation that generated the recent exception.
getManager(ClassLoader, String) - Method in interface org.cache2k.spi.Cache2kCoreProvider
getMaxRetryInterval() - Method in class org.cache2k.configuration.Cache2kConfiguration
getMaxRetryIntervalMillis() - Method in interface org.cache2k.integration.ResiliencePolicy.Context: Maximum retry interval.
getName() - Method in interface org.cache2k.Cache: A configured or generated name of this cache instance.
getName() - Method in class org.cache2k.CacheManager: The name to uniquely identify the manager within a VM instance.
getName() - Method in class org.cache2k.configuration.Cache2kConfiguration
getOldValue() - Method in interface org.cache2k.processor.MutableCacheEntry: The current value in the cache.
getPrefetchExecutor() - Method in class org.cache2k.configuration.Cache2kConfiguration
getProperties() - Method in class org.cache2k.CacheManager: Properties for the cache manager, never null.
getResilienceDuration() - Method in class org.cache2k.configuration.Cache2kConfiguration
getResilienceDurationMillis() - Method in interface org.cache2k.integration.ResiliencePolicy.Context: Maximum time exceptions should be suppressed.
getResiliencePolicy() - Method in class org.cache2k.configuration.Cache2kConfiguration
getResult() - Method in interface org.cache2k.processor.EntryProcessingResult: Result of entry processing.
getRetryCount() - Method in interface org.cache2k.integration.ExceptionInformation: Number of retry attempts to load the value for the requested key.
getRetryInterval() - Method in class org.cache2k.configuration.Cache2kConfiguration
getRetryIntervalMillis() - Method in interface org.cache2k.integration.ResiliencePolicy.Context: Retry interval after the first exception happened for a key.
getSection(Class<T>) - Method in class org.cache2k.configuration.ConfigurationSectionContainer: Retrieve a single section from the container.
getSections() - Method in class org.cache2k.configuration.Cache2kConfiguration: Mutable collection of additional configuration sections
getSections() - Method in interface org.cache2k.configuration.ConfigurationWithSections
getSinceTime() - Method in interface org.cache2k.integration.ExceptionInformation: Start time of the load that generated the first exception.
getType() - Method in interface org.cache2k.configuration.CacheType: Class type if not an array.
getType() - Method in class org.cache2k.configuration.CacheTypeCapture
getType() - Method in class org.cache2k.configuration.CacheTypeCapture.OfClass
getType() - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
getTypeArguments() - Method in interface org.cache2k.configuration.CacheType: Known type arguments, if the type is a parametrized type.
getTypeArguments() - Method in class org.cache2k.configuration.CacheTypeCapture
getTypeArguments() - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
getTypeName() - Method in interface org.cache2k.configuration.CacheType: Java language compatible type name
getTypeName() - Method in class org.cache2k.configuration.CacheTypeCapture
getTypeName() - Method in class org.cache2k.configuration.CacheTypeCapture.OfArray
getTypeName() - Method in class org.cache2k.configuration.CacheTypeCapture.OfClass
getTypeName() - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
getUntil() - Method in interface org.cache2k.integration.ExceptionInformation: Time in millis until the next retry attempt.
getValue() - Method in interface org.cache2k.CacheEntry: Value of the entry.
getValue() - Method in interface org.cache2k.processor.MutableCacheEntry: Returns the value to which the cache associated the key, or null if the cache contains no mapping for this key.
getValueType() - Method in class org.cache2k.configuration.Cache2kConfiguration
getWriter() - Method in class org.cache2k.configuration.Cache2kConfiguration

H

hasAsyncListeners() - Method in class org.cache2k.configuration.Cache2kConfiguration
hashCode() - Method in class org.cache2k.configuration.CacheTypeCapture
hashCode() - Method in class org.cache2k.configuration.CacheTypeCapture.OfArray
hashCode() - Method in class org.cache2k.configuration.CacheTypeCapture.OfClass
hashCode() - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
hashCode() - Method in class org.cache2k.configuration.CustomizationReferenceSupplier
hashCode() - Method in class org.cache2k.configuration.CustomizationSupplierByClassName
hasListeners() - Method in class org.cache2k.configuration.Cache2kConfiguration
hasTypeArguments() - Method in interface org.cache2k.configuration.CacheType: The type has generic type parameters and the concrete types are known.
hasTypeArguments() - Method in class org.cache2k.configuration.CacheTypeCapture
hasTypeArguments() - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric

I

init(ResiliencePolicy.Context) - Method in class org.cache2k.integration.ResiliencePolicy: Called before any other call.
invoke(K, EntryProcessor<K, V, R>) - Method in interface org.cache2k.Cache: Invoke a user defined function on a cache entry.
invokeAll(Iterable<? extends K>, EntryProcessor<K, V, R>) - Method in interface org.cache2k.Cache: Invoke a user defined function on multiple cache entries specified by the keys parameter.
isArray() - Method in interface org.cache2k.configuration.CacheType: This type is an array.
isArray() - Method in class org.cache2k.configuration.CacheTypeCapture
isArray() - Method in class org.cache2k.configuration.CacheTypeCapture.OfArray
isBoostConcurrency() - Method in class org.cache2k.configuration.Cache2kConfiguration
isClosed() - Method in interface org.cache2k.Cache: Returns true if cache was closed or closing is in progress.
isClosed() - Method in class org.cache2k.CacheManager: Returns true if this cache manager was closed.
isDefaultManager() - Method in class org.cache2k.CacheManager: True if this is the default manager of the application, returned by CacheManager.getInstance()
isDisableLastModificationTime() - Method in class org.cache2k.configuration.Cache2kConfiguration
isDisableStatistics() - Method in class org.cache2k.configuration.Cache2kConfiguration
isEmpty() - Method in class org.cache2k.configuration.DefaultCustomizationCollection
isEternal() - Method in class org.cache2k.configuration.Cache2kConfiguration
isExternalConfigurationPresent() - Method in class org.cache2k.configuration.Cache2kConfiguration
isKeepDataAfterExpired() - Method in class org.cache2k.configuration.Cache2kConfiguration
isPermitNullValues() - Method in class org.cache2k.configuration.Cache2kConfiguration
isRefreshAhead() - Method in class org.cache2k.configuration.Cache2kConfiguration
isSharpExpiry() - Method in class org.cache2k.configuration.Cache2kConfiguration
isStoreByReference() - Method in class org.cache2k.configuration.Cache2kConfiguration
isStrictEviction() - Method in class org.cache2k.configuration.Cache2kConfiguration
isSuppressExceptions() - Method in class org.cache2k.configuration.Cache2kConfiguration
iterator() - Method in class org.cache2k.configuration.ConfigurationSectionContainer
iterator() - Method in class org.cache2k.configuration.DefaultCustomizationCollection

K

keepDataAfterExpired(boolean) - Method in class org.cache2k.Cache2kBuilder: Expired data is kept in the cache until the entry is evicted.
keys() - Method in interface org.cache2k.Cache: Iterate all keys in the cache.
keyType(Class<K2>) - Method in class org.cache2k.Cache2kBuilder: The used type of the cache key.
keyType(CacheType<K2>) - Method in class org.cache2k.Cache2kBuilder: The used type of the cache key.
KeyValueSource<K,V> - Interface in org.cache2k: Reduced interface to return a value selected by a key object.
KeyValueStore<K,V> - Interface in org.cache2k: Reduced interface for read/write data access.

L

load(K, long, CacheEntry<K, V>) - Method in class org.cache2k.integration.AdvancedCacheLoader: Retrieves or generates data based on the key.
load(K) - Method in class org.cache2k.integration.CacheLoader: Retrieves or generates data based on the key.
load(K) - Method in interface org.cache2k.integration.FunctionalCacheLoader
loadAll(Iterable<? extends K>, CacheOperationCompletionListener) - Method in interface org.cache2k.Cache: Asynchronously loads the given set of keys into the cache.
loadAll(Iterable<? extends K>, Executor) - Method in class org.cache2k.integration.CacheLoader: Loads multiple values to the cache.
loader(FunctionalCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder
loader(AdvancedCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder
loaderExecutor(Executor) - Method in class org.cache2k.Cache2kBuilder: Thread pool / executor service to use for asynchronous load operations.
loaderThreadCount(int) - Method in class org.cache2k.Cache2kBuilder: If no separate executor is set via Cache2kBuilder.loaderExecutor(Executor) the cache will create a separate thread pool used exclusively by it.

M

manager(CacheManager) - Method in class org.cache2k.Cache2kBuilder: The manager, the created cache will belong to.
maxRetryInterval(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder: If a loader exception happens, this is the maximum time interval after a retry attempt is made.
mixTimeSpanAndPointInTime(long, long, long) - Static method in class org.cache2k.expiry.Expiry: Combine a refresh time span and an expiry at a specified point in time.
MutableCacheEntry<K,V> - Interface in org.cache2k.processor: A mutable entry is used inside the EntryProcessor to perform updates and retrieve information from a cache entry.

N

name(String, Class<?>, String) - Method in class org.cache2k.Cache2kBuilder: Constructs a cache name out of the class name, a field name and a unique name identifying the component in the application.
name(Class<?>, String) - Method in class org.cache2k.Cache2kBuilder: Constructs a cache name out of the class name and field name.
name(Class<?>) - Method in class org.cache2k.Cache2kBuilder: Sets a cache name from the fully qualified class name.
name(String) - Method in class org.cache2k.Cache2kBuilder: Sets the name of a cache.
NEUTRAL - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: Don't change the expiry of the entry.
NO_CACHE - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: Value should not be cached.
NOW - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: Identical to ExpiryTimeValues.NO_CACHE.

O

of(Class<K>, Class<T>) - Static method in class org.cache2k.Cache2kBuilder: Create a new cache builder for key and value types of classes with no generic parameters.
of(Cache2kConfiguration<K, T>) - Static method in class org.cache2k.Cache2kBuilder: Create a builder from the configuration.
of(Class<K>, Class<V>) - Static method in class org.cache2k.configuration.Cache2kConfiguration: Construct a config instance setting the type parameters and returning a proper generic type.
of(Class<K>, CacheType<V>) - Static method in class org.cache2k.configuration.Cache2kConfiguration: Construct a config instance setting the type parameters and returning a proper generic type.
of(CacheType<K>, Class<V>) - Static method in class org.cache2k.configuration.Cache2kConfiguration: Construct a config instance setting the type parameters and returning a proper generic type.
of(CacheType<K>, CacheType<V>) - Static method in class org.cache2k.configuration.Cache2kConfiguration: Construct a config instance setting the type parameters and returning a proper generic type.
of(Type) - Static method in class org.cache2k.configuration.CacheTypeCapture
OfArray() - Constructor for class org.cache2k.configuration.CacheTypeCapture.OfArray: Empty constructor for bean compliance.
OfArray(CacheType) - Constructor for class org.cache2k.configuration.CacheTypeCapture.OfArray
OfClass() - Constructor for class org.cache2k.configuration.CacheTypeCapture.OfClass: Empty constructor for bean compliance.
OfClass(Class<?>) - Constructor for class org.cache2k.configuration.CacheTypeCapture.OfClass
OfGeneric() - Constructor for class org.cache2k.configuration.CacheTypeCapture.OfGeneric: Empty constructor for bean compliance.
OfGeneric(Class<?>, CacheType[]) - Constructor for class org.cache2k.configuration.CacheTypeCapture.OfGeneric
onCompleted() - Method in interface org.cache2k.CacheOperationCompletionListener: Signals the completion of a Cache.loadAll(java.lang.Iterable<? extends K>, org.cache2k.CacheOperationCompletionListener), Cache.reloadAll(java.lang.Iterable<? extends K>, org.cache2k.CacheOperationCompletionListener) or Cache.prefetchAll(java.lang.Iterable<? extends K>, org.cache2k.CacheOperationCompletionListener) operation.
onEntryCreated(Cache<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.event.CacheEntryCreatedListener: Called after a creation of a cache entry and after all cache writers ran successfully.
onEntryExpired(Cache<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.event.CacheEntryExpiredListener: Called after the expiry of an entry.
onEntryRemoved(Cache<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.event.CacheEntryRemovedListener: Called after the removal of a cache entry and after all cache writers ran successfully.
onEntryUpdated(Cache<K, V>, CacheEntry<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.event.CacheEntryUpdatedListener: Called after a mutation of a cache entry and after all cache writers ran successfully.
onException(Throwable) - Method in interface org.cache2k.CacheOperationCompletionListener: The operation could not completed, because of an error.
org.cache2k - package org.cache2k: API package for cache2k Java caching library.
org.cache2k.configuration - package org.cache2k.configuration: The cache configuration as a Java bean and support types.
org.cache2k.event - package org.cache2k.event: Events that are fired on behalf of a cache operation.
org.cache2k.expiry - package org.cache2k.expiry: Set of interfaces for customizing the expiry behavior.
org.cache2k.integration - package org.cache2k.integration: Loader and writer to integrate with external data sources.
org.cache2k.processor - package org.cache2k.processor: Entry processor and supporting types for custom atomic operations on a cache entry.
org.cache2k.spi - package org.cache2k.spi: Service provider interface that is used by the cache2k implementation.

P

peek(K) - Method in interface org.cache2k.Cache: Returns the value associated to the given key.
peekAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Bulk version for Cache.peek(Object)
peekAndPut(K, V) - Method in interface org.cache2k.Cache: Updates an existing cache entry for the specified key, so it associates the given value, or, insert a new cache entry for this key and value.
peekAndRemove(K) - Method in interface org.cache2k.Cache: Removes the mapping for a key from the cache if it is present.
peekAndReplace(K, V) - Method in interface org.cache2k.Cache: Replaces the entry for a key only if currently mapped to some value.
peekEntry(K) - Method in interface org.cache2k.Cache: Returns an entry that contains the cache value associated with the given key.
permitNullValues(boolean) - Method in class org.cache2k.Cache2kBuilder: When true, null values are allowed in the cache.
prefetch(K) - Method in interface org.cache2k.AdvancedKeyValueSource: Notify the cache about the intention to retrieve the value for this key in the near future.
prefetch(K) - Method in interface org.cache2k.Cache: Notifies the cache about the intention to retrieve the value for this key in the near future.
prefetchAll(Iterable<? extends K>, CacheOperationCompletionListener) - Method in interface org.cache2k.AdvancedKeyValueSource: Notify the cache about the intention to retrieve the value for the keys in the near future.
prefetchAll(Iterable<? extends K>, CacheOperationCompletionListener) - Method in interface org.cache2k.Cache: Notifies the cache about the intention to retrieve the value for this key in the near future.
prefetchExecutor(Executor) - Method in class org.cache2k.Cache2kBuilder: Thread pool / executor service to use for refresh ahead and prefetch operations.
process(MutableCacheEntry<K, V>) - Method in interface org.cache2k.processor.EntryProcessor: Examines or mutates an entry.
propagateException(K, ExceptionInformation) - Method in interface org.cache2k.integration.ExceptionPropagator: Generate runtime exception to throw.
PROVIDER - Static variable in class org.cache2k.CacheManager
put(K, V) - Method in interface org.cache2k.Cache: Inserts a new value associated with the given key or updates an existing association of the same key with the new value.
put(K, V) - Method in interface org.cache2k.KeyValueStore: Insert or update a value associated with the given key.
putAll(Map<? extends K, ? extends V>) - Method in interface org.cache2k.Cache: Insert all elements of the map into the cache.
putAll(Map<? extends K, ? extends V>) - Method in interface org.cache2k.KeyValueStore: Insert or update all elements of the map into the cache.
putIfAbsent(K, V) - Method in interface org.cache2k.Cache: If the specified key is not already associated with a value, associate it with the given value.

R

REFRESH - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: An immediate load is triggered if refreshAhead is enabled.
refreshAhead(boolean) - Method in class org.cache2k.Cache2kBuilder: When true, enable background refresh / refresh ahead.
registerCache2kExtension() - Method in interface org.cache2k.spi.Cache2kExtensionProvider
reloadAll(Iterable<? extends K>, CacheOperationCompletionListener) - Method in interface org.cache2k.Cache: Asynchronously loads the given set of keys into the cache.
remove(K) - Method in interface org.cache2k.Cache: Removes the mapping for a key from the cache if it is present.
remove(Object) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
remove(K) - Method in interface org.cache2k.KeyValueStore: Remove a value from the cache that is associated with the key.
remove() - Method in interface org.cache2k.processor.MutableCacheEntry: Removes an entry from the cache.
removeAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Removes a set of keys.
removeAll() - Method in interface org.cache2k.Cache: Removes all cache contents.
removeAll(Collection<?>) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
removeAll(Iterable<? extends K>) - Method in interface org.cache2k.KeyValueStore: Remove mappings from the cache.
removeIfEquals(K, V) - Method in interface org.cache2k.Cache: Remove the mapping if the stored value is the equal to the comparison value.
replace(K, V) - Method in interface org.cache2k.Cache: Replaces the entry for a key only if currently mapped to some value.
replaceIfEquals(K, V, V) - Method in interface org.cache2k.Cache: Replaces the entry for a key only if currently mapped to a given value.
requestInterface(Class<X>) - Method in interface org.cache2k.Cache: Request an alternative interface for this cache instance.
resilienceDuration(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder: Time span the cache will suppress loader exceptions if a value is available from a previous load.
resiliencePolicy(ResiliencePolicy<K, V>) - Method in class org.cache2k.Cache2kBuilder: Sets a custom resilience policy to control the cache behavior in the presence of exceptions from the loader.
ResiliencePolicy<K,V> - Class in org.cache2k.integration: Controls how to deal with loader exceptions in a read through configuration.
ResiliencePolicy() - Constructor for class org.cache2k.integration.ResiliencePolicy
ResiliencePolicy.Context - Interface in org.cache2k.integration: Provides additional context information.
resolve(Class<T>) - Static method in class org.cache2k.spi.SingleProviderResolver: Return a provider for this interface.
resolveMandatory(Class<T>) - Static method in class org.cache2k.spi.SingleProviderResolver: Return a provider for this interface.
RestartException - Exception in org.cache2k.processor: Used by the entry processor to abort the processing to carry out some, possibly asynchronous, processing.
RestartException() - Constructor for exception org.cache2k.processor.RestartException
retainAll(Collection<?>) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
retryInterval(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder: If a loader exception happens, this is the time interval after a retry attempt is made.
retryLoadAfter(K, ExceptionInformation) - Method in class org.cache2k.integration.ResiliencePolicy: Called after the loader threw an exception and no previous value is available or ResiliencePolicy.suppressExceptionUntil(K, org.cache2k.integration.ExceptionInformation, org.cache2k.CacheEntry<K, V>) returned zero.

S

setAdvancedLoader(CustomizationSupplier<AdvancedCacheLoader<K, V>>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setAsyncListenerExecutor(CustomizationSupplier<Executor>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setBoostConcurrency(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setClassName(String) - Method in class org.cache2k.configuration.CustomizationSupplierByClassName
setComponentType(CacheType) - Method in class org.cache2k.configuration.CacheTypeCapture.OfArray
setDefaultManagerName(ClassLoader, String) - Method in interface org.cache2k.spi.Cache2kCoreProvider
setDefaultName(String) - Static method in class org.cache2k.CacheManager: Change the default manager name.
setDisableLastModificationTime(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setDisableStatistics(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setEntryCapacity(long) - Method in class org.cache2k.configuration.Cache2kConfiguration
setEternal(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setException(Throwable) - Method in interface org.cache2k.processor.MutableCacheEntry: Insert or update the entry and sets an exception.
setExceptionPropagator(CustomizationSupplier<ExceptionPropagator<K>>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setExpireAfterWrite(long) - Method in class org.cache2k.configuration.Cache2kConfiguration
setExpiry(long) - Method in interface org.cache2k.processor.MutableCacheEntry: Set a new expiry time for the entry.
setExpiryPolicy(CustomizationSupplier<ExpiryPolicy<K, V>>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setExternalConfigurationPresent(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration: True, if an external configuration for the cache was found and is applied.
setKeepDataAfterExpired(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setKeyType(Class<?>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setKeyType(CacheType) - Method in class org.cache2k.configuration.Cache2kConfiguration
setLoader(CustomizationSupplier<? extends FunctionalCacheLoader<K, V>>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setLoaderExecutor(CustomizationSupplier<Executor>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setLoaderThreadCount(int) - Method in class org.cache2k.configuration.Cache2kConfiguration
setMaxRetryInterval(long) - Method in class org.cache2k.configuration.Cache2kConfiguration
setName(String) - Method in class org.cache2k.configuration.Cache2kConfiguration
setPermitNullValues(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setPrefetchExecutor(CustomizationSupplier<Executor>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setRefreshAhead(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setResilienceDuration(long) - Method in class org.cache2k.configuration.Cache2kConfiguration
setResiliencePolicy(CustomizationSupplier<ResiliencePolicy<K, V>>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setRetryInterval(long) - Method in class org.cache2k.configuration.Cache2kConfiguration
setSharpExpiry(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setStoreByReference(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setStrictEviction(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setSuppressExceptions(boolean) - Method in class org.cache2k.configuration.Cache2kConfiguration
setType(Class<?>) - Method in class org.cache2k.configuration.CacheTypeCapture.OfClass: Setter for bean compliance
setType(Class<?>) - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
setTypeArguments(CacheType[]) - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
setValue(V) - Method in interface org.cache2k.processor.MutableCacheEntry: Insert or updates the cache value assigned to this key.
setValueType(Class<?>) - Method in class org.cache2k.configuration.Cache2kConfiguration
setValueType(CacheType) - Method in class org.cache2k.configuration.Cache2kConfiguration
setWriter(CustomizationSupplier<CacheWriter<K, V>>) - Method in class org.cache2k.configuration.Cache2kConfiguration
sharpExpiry(boolean) - Method in class org.cache2k.Cache2kBuilder: By default the expiry time is not exact, which means, a value might be visible a few milliseconds after the time of expiry.
SingleProviderResolver - Class in org.cache2k.spi: Resolves a service provider by its interface.
SingleProviderResolver() - Constructor for class org.cache2k.spi.SingleProviderResolver
SingletonConfigurationSection - Interface in org.cache2k.configuration: A configuration section that may appear only once.
size() - Method in class org.cache2k.configuration.DefaultCustomizationCollection
storeByReference(boolean) - Method in class org.cache2k.Cache2kBuilder: Ensure that the cache value is stored via direct object reference and that no serialization takes place.
strictEviction(boolean) - Method in class org.cache2k.Cache2kBuilder: To increase performance cache2k optimizes the eviction and does eviction in greater chunks.
supply(CacheManager) - Method in class org.cache2k.configuration.CustomizationReferenceSupplier
supply(CacheManager) - Method in interface org.cache2k.configuration.CustomizationSupplier: Create or return an existing customization instance.
supply(CacheManager) - Method in class org.cache2k.configuration.CustomizationSupplierByClassName
suppressExceptions(boolean) - Method in class org.cache2k.Cache2kBuilder: Suppress an exception from the cache loader, if there is previous data.
suppressExceptionUntil(K, ExceptionInformation, CacheEntry<K, V>) - Method in class org.cache2k.integration.ResiliencePolicy: Called after the loader threw an exception and a previous value is available.

T

toArray() - Method in class org.cache2k.configuration.DefaultCustomizationCollection
toArray(T[]) - Method in class org.cache2k.configuration.DefaultCustomizationCollection
toConfiguration() - Method in class org.cache2k.Cache2kBuilder: Returns the configuration object this builder operates on.
toSharpTime(long) - Static method in class org.cache2k.expiry.Expiry: Convert the time value to a time representing an a sharp expiry.
toString() - Method in interface org.cache2k.Cache: Returns internal information.

V

valueType(Class<T2>) - Method in class org.cache2k.Cache2kBuilder: Sets the value type to use.
valueType(CacheType<T2>) - Method in class org.cache2k.Cache2kBuilder: Sets the value type to use.
ValueWithExpiryTime - Interface in org.cache2k.expiry: Interface to add to a value object if it is possible to derive the expiry time from the value.

W

wasExisting() - Method in interface org.cache2k.processor.MutableCacheEntry: True if a mapping exists in the cache, never invokes the loader / cache source.
with(ConfigurationSectionBuilder<? extends ConfigurationSection>...) - Method in class org.cache2k.Cache2kBuilder: Add a new configuration sub section.
write(K, V) - Method in class org.cache2k.integration.CacheWriter: Called when the value was updated or inserted into the cache.
writer(CacheWriter<K, V>) - Method in class org.cache2k.Cache2kBuilder

A B C D E F G H I K L M N O P R S T V W