Index (cache2k API 2.6.1.Final API)

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

A

AbstractCache<K,V> - Class in org.cache2k: Base class for implementations of the cache interface.
AbstractCache() - Constructor for class org.cache2k.AbstractCache
add(ConfigSection<?, ?>) - Method in class org.cache2k.config.SectionContainer: Add a new configuration section to the container.
addAsyncListener(CacheEntryOperationListener<K, V>) - Method in class org.cache2k.Cache2kBuilder: A set of listeners.
addCacheClosedListener(CacheClosedListener) - Method in class org.cache2k.Cache2kBuilder: Listener that is called after a cache is closed.
addListener(CacheEntryOperationListener<K, V>) - Method in class org.cache2k.Cache2kBuilder: Add a listener.
AdvancedCacheLoader<K,V> - Interface in org.cache2k.io: Retrieves or generates a value to load into the cache.
asMap() - Method in class org.cache2k.AbstractCache
asMap() - Method in interface org.cache2k.Cache: Returns a map interface for operating with this cache.
asMap() - Method in class org.cache2k.ForwardingCache
AsyncBulkCacheLoader<K,V> - Interface in org.cache2k.io: Extension of AsyncCacheLoader with bulk load capabilities.
AsyncBulkCacheLoader.BulkCallback<K,V> - Interface in org.cache2k.io
AsyncBulkCacheLoader.BulkLoadContext<K,V> - Interface in org.cache2k.io
AsyncCacheLoader<K,V> - Interface in org.cache2k.io: Alternative interface to CacheLoader for asynchronous operation.
AsyncCacheLoader.Callback<V> - Interface in org.cache2k.io: Callback for async cache load.
AsyncCacheLoader.Context<K,V> - Interface in org.cache2k.io: Relevant context information for a single load request.
asyncListenerExecutor(Executor) - Method in class org.cache2k.Cache2kBuilder: Executor for asynchronous listeners.

B

BeanMarker - Interface in org.cache2k.config: Marks the class as bean compatible, meaning, it has a public default constructor and getter and setters for all its properties.
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.
builder() - Method in class org.cache2k.config.Cache2kConfig: Creates a cache builder from the configuration.
builder() - Method in class org.cache2k.config.Cache2kManagerConfig: Not supported, but will eventually get one.
builder() - Method in interface org.cache2k.config.ConfigBean
builder() - Method in interface org.cache2k.config.ConfigSection
builder() - Method in class org.cache2k.config.CustomizationSupplierByClassName
Builder() - Constructor for class org.cache2k.config.Cache2kManagerConfig.Builder
BulkCacheLoader<K,V> - Interface in org.cache2k.io: Extension to the cache load with bulk load capabilities.
bulkLoader(AsyncBulkCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder
bulkLoader(BulkCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder

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 with 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:
Cache2kConfig<K,V> - Class in org.cache2k.config: Configuration for a cache2k cache.
Cache2kConfig() - Constructor for class org.cache2k.config.Cache2kConfig
Cache2kCoreProvider - Interface in org.cache2k.spi: Interface to the cache2k implementation.
Cache2kManagerConfig - Class in org.cache2k.config: Configuration options for a cache manager.
Cache2kManagerConfig() - Constructor for class org.cache2k.config.Cache2kManagerConfig
Cache2kManagerConfig.Builder - Class in org.cache2k.config
CacheBuildContext<K,V> - Interface in org.cache2k.config: Access to configuration and cache manager properties during the construction of the cache object.
CacheClosedException - Exception in org.cache2k: Consistently this exception is thrown, when an operation detects that the cache is closed.
CacheClosedException() - Constructor for exception org.cache2k.CacheClosedException
CacheClosedException(Cache<?, ?>) - Constructor for exception org.cache2k.CacheClosedException: This is the preferred constructor.
CacheClosedListener - Interface in org.cache2k.event: Listener called when cache is closed.
CacheControl - Interface in org.cache2k.operation: Combined interface for introspection and control functions of a cache relevant for management and monitoring.
CacheCreatedListener - Interface in org.cache2k.event
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.
CacheEntryEvictedListener<K,V> - Interface in org.cache2k.event: Called when an entry gets evicted by the cache.
CacheEntryExpiredListener<K,V> - Interface in org.cache2k.event: Listener called when an entry expires.
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.
CacheEventListenerException - Exception in org.cache2k.event: Wrapped exception if a listener throws an exception.
CacheEventListenerException(Throwable) - Constructor for exception org.cache2k.event.CacheEventListenerException
CacheException - Exception in org.cache2k: Base class of all cache exceptions.
CacheException() - Constructor for exception org.cache2k.CacheException
CacheException(String, Throwable, boolean, boolean) - 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
CacheInfo - Interface in org.cache2k.operation: Information of a cache for introspection at runtime, for generic monitoring and management proposes.
CacheLifecycleListener - Interface in org.cache2k.event: Listeners for lifecycle events of a cache.
CacheLoader<K,V> - Interface in org.cache2k.io: Retrieves or generates a value to load into the cache.
CacheLoaderException - Exception in org.cache2k.io: Exception to wrap a loader exception.
CacheLoaderException(String, Throwable) - Constructor for exception org.cache2k.io.CacheLoaderException
CacheLoaderException(Throwable) - Constructor for exception org.cache2k.io.CacheLoaderException
CacheManager - Class in org.cache2k: A cache manager holds a set of caches.
CacheManager() - Constructor for class org.cache2k.CacheManager
CacheOperation - Interface in org.cache2k.operation: Commands to influence the cache operation in general.
CacheStatistics - Interface in org.cache2k.operation: Set of metrics for cache statistics.
CacheType<T> - Interface in org.cache2k.config: 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.config: Helper class to capture generic types into a type descriptor.
CacheTypeCapture() - Constructor for class org.cache2k.config.CacheTypeCapture
CacheTypeCapture.OfArray - Class in org.cache2k.config: CacheType representing an array.
CacheTypeCapture.OfClass<T> - Class in org.cache2k.config: CacheType representing a class.
CacheTypeCapture.OfGeneric<T> - Class in org.cache2k.config: CacheType representing a generic type.
CacheWrapper - Interface in org.cache2k.config: Wraps a cache in order to add functionality like tracing.
CacheWriter<K,V> - Interface in org.cache2k.io: Writer for write-through configurations.
CacheWriterException - Exception in org.cache2k.io: Wraps an exception caused by a writer.
CacheWriterException(Throwable) - Constructor for exception org.cache2k.io.CacheWriterException
calculateExpiryTime(K, V, long, CacheEntry<K, V>) - Method in interface org.cache2k.expiry.ExpiryPolicy: Returns the time of expiry in milliseconds since epoch.
changeCapacity(long) - Method in interface org.cache2k.operation.CacheOperation: Change the maximum capacity of the cache.
clear() - Method in class org.cache2k.AbstractCache
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.ForwardingCache
clear() - Method in interface org.cache2k.operation.CacheOperation: Clears the cache contents.
close() - Method in class org.cache2k.AbstractCache
close() - Method in interface org.cache2k.Cache: Release resources in the local VM and remove the cache from the CacheManager.
close() - Method in class org.cache2k.CacheManager: Free all resources from managed caches.
close() - Method in class org.cache2k.ForwardingCache
close() - Method in interface org.cache2k.operation.CacheOperation: End cache operations.
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) - Static method in class org.cache2k.CacheManager: Close the named cache manager.
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.
computeIfAbsent(K, Function<? super K, ? extends V>) - Method in class org.cache2k.AbstractCache
computeIfAbsent(K, Function<? super K, ? extends V>) - Method in interface org.cache2k.Cache: If the specified key is not already associated with a value (or exception), call the provided task and associate it with the returned value.
computeIfAbsent(K, Function<? super K, ? extends V>) - Method in class org.cache2k.ForwardingCache
config() - Method in class org.cache2k.Cache2kBuilder: Returns the configuration object this builder operates on.
config() - Method in class org.cache2k.config.Cache2kManagerConfig.Builder
config() - Method in interface org.cache2k.config.ConfigBuilder
ConfigBean<SELF extends ConfigBean<SELF,B>,B extends ConfigBuilder<B,SELF>> - Interface in org.cache2k.config: Marker for cache configuration beans.
ConfigBuilder<SELF extends ConfigBuilder<SELF,T>,T extends ConfigBean<T,SELF>> - Interface in org.cache2k.config
ConfigSection<SELF extends ConfigSection<SELF,B>,B extends SectionBuilder<B,SELF>> - Interface in org.cache2k.config: A configuration section.
ConfigWithSections - Interface in org.cache2k.config: If the configuration bean has additional sub configuration beans, then it implements this interface.
containsAndRemove(K) - Method in class org.cache2k.AbstractCache
containsAndRemove(K) - Method in interface org.cache2k.Cache: Check for existing mapping and remove it.
containsAndRemove(K) - Method in class org.cache2k.ForwardingCache
containsKey(K) - Method in class org.cache2k.AbstractCache
containsKey(K) - Method in interface org.cache2k.Cache: Returns true, if there is a mapping for the specified key.
containsKey(K) - Method in class org.cache2k.ForwardingCache
createCache(CacheManager, Cache2kConfig<K, V>) - Method in interface org.cache2k.spi.Cache2kCoreProvider: Create a cache, apply external configuration before creating it.
createCache(Cache2kConfig<K, V>) - Method in class org.cache2k.CacheManager: Create a new cache from the configuration.
createCustomization(CustomizationSupplier<T>) - Method in interface org.cache2k.config.CacheBuildContext
Customization - Interface in org.cache2k: A customization dealing with cached data.
CustomizationException - Exception in org.cache2k: Wraps an exception thrown from a cache customization such as the ExpiryPolicy, CacheLoader or CacheEntryOperationListener
CustomizationException(String) - Constructor for exception org.cache2k.CustomizationException
CustomizationException(String, Throwable) - Constructor for exception org.cache2k.CustomizationException
CustomizationException(Throwable) - Constructor for exception org.cache2k.CustomizationException
CustomizationReferenceSupplier<T> - Class in org.cache2k.config: A reference to the customization to be used is set while building the cache.
CustomizationReferenceSupplier(T) - Constructor for class org.cache2k.config.CustomizationReferenceSupplier: Construct a customization factory that returns always the same object instance.
CustomizationSupplier<T> - Interface in org.cache2k.config: Supplies cache customizations like ExpiryPolicy or CacheLoader.
CustomizationSupplierByClassName<T> - Class in org.cache2k.config: 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.config.CustomizationSupplierByClassName: Default constructor for beans.
CustomizationSupplierByClassName(String) - Constructor for class org.cache2k.config.CustomizationSupplierByClassName: Construct a customization factory based on the class name.

D

DataAware<K,V> - Interface in org.cache2k: Parent for all interfaces dealing with cached data.
DataAwareCustomization<K,V> - Interface in org.cache2k: Parent for all customizations dealing with cached data.
DataCustomizationSupplier<K,V,T extends DataAwareCustomization<K,V>> - Interface in org.cache2k.config
DEFAULT - Static variable in interface org.cache2k.operation.TimeReference: Default implementation using System.currentTimeMillis() as time reference.
DEFAULT_ENTRY_CAPACITY - Static variable in class org.cache2k.config.Cache2kConfig: Default entry capacity of a cache.
delegate() - Method in class org.cache2k.ForwardingCache: Subclasses need to implement this method which specifies the delegation target.
delete(K) - Method in interface org.cache2k.io.CacheWriter: Called when a mapping is removed from the cache.
DESCRIPTOR_TO_STRING_PREFIX - Static variable in interface org.cache2k.config.CacheType: The used prefix for the toString() output.
destroy() - Method in interface org.cache2k.operation.CacheOperation: A combination of Cache.clear() and Cache.close() wiping all stored data of this cache.
disable(Class<? extends ToggleFeature>) - Method in class org.cache2k.Cache2kBuilder
disable(Cache2kBuilder<?, ?>, Class<? extends ToggleFeature>) - Static method in class org.cache2k.config.ToggleFeature: Disable the feature by removing it from the configuration.
disable(Cache2kBuilder<K, V>) - Static method in interface org.cache2k.io.ResiliencePolicy
DISABLED_POLICY - Static variable in interface org.cache2k.io.ResiliencePolicy: A policy always returning zero, thus disabling resilience features.
disabledPolicy() - Static method in interface org.cache2k.io.ResiliencePolicy
disableMonitoring(boolean) - Method in class org.cache2k.Cache2kBuilder: Disables reporting of cache metrics to monitoring systems or management.
disableStatistics(boolean) - Method in class org.cache2k.Cache2kBuilder: By default, statistic gathering is enabled.
doEnlist(CacheBuildContext<K, V>) - Method in class org.cache2k.config.ToggleFeature

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.
enable(Class<? extends ToggleFeature>) - Method in class org.cache2k.Cache2kBuilder: Enable a feature
enable(Class<T>, Consumer) - Method in class org.cache2k.Cache2kBuilder: Enables a toggle feature which has additional parameters and configures it via its builder.
enable(Cache2kBuilder<?, ?>, Class<T>) - Static method in class org.cache2k.config.ToggleFeature: Enable the feature in the main configuration.
enableWith(Class<T>, Consumer) - Method in class org.cache2k.Cache2kBuilder: Enables a feature and configures its associated configuration section via its builder.
enlist(CacheBuildContext<K, V>) - Method in interface org.cache2k.config.Feature: The feature enables itself by augmenting the cache config.
enlist(CacheBuildContext<K, V>) - Method in class org.cache2k.config.ToggleFeature: Checks whether enabled and call implementations doEnlist method.
entries() - Method in class org.cache2k.AbstractCache
entries() - Method in interface org.cache2k.Cache: All entries in the cache.
entries() - Method in class org.cache2k.ForwardingCache
entryCapacity(long) - Method in class org.cache2k.Cache2kBuilder: The maximum number of entries hold by the cache.
EntryMutator<K,V> - Interface in org.cache2k.processor: Identical to the processor but does not return a result.
EntryProcessingException - Exception in org.cache2k.processor: The wrapped exception from 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.config.CustomizationReferenceSupplier
equals(Object) - Method in class org.cache2k.config.CustomizationSupplierByClassName
equals(Object) - Method in class org.cache2k.config.ToggleFeature: Identical if it is the same implementation class.
equals(Object) - Method in class org.cache2k.config.CacheTypeCapture
equals(Object) - Method in class org.cache2k.config.CacheTypeCapture.OfArray
equals(Object) - Method in class org.cache2k.config.CacheTypeCapture.OfClass
equals(Object) - Method in class org.cache2k.config.CacheTypeCapture.OfGeneric
eternal(boolean) - Method in class org.cache2k.Cache2kBuilder: When set to true, cached values do not expire and do not need refreshing.
ETERNAL - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: Return value signalling to keep the value forever in the cache, switching off expiry.
exceptionPropagator(ExceptionPropagator<? super K, ? super V>) - Method in class org.cache2k.Cache2kBuilder: Sets customization for propagating loader exceptions.
ExceptionPropagator<K,V> - Interface in org.cache2k.io: In read through mode exceptions are cached.
execute(Runnable) - Method in interface org.cache2k.operation.Scheduler: Run a task immediately, usually via the common ForkJoinPool.
executor(Executor) - Method in class org.cache2k.Cache2kBuilder: Executor for asynchronous operations and expiry.
exists() - Method in interface org.cache2k.processor.MutableCacheEntry: True if a mapping exists in the cache, never invokes the loader.
expireAfterWrite(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder
expireAfterWrite(Duration) - Method in class org.cache2k.Cache2kBuilder: Duration after an entry expires after an insert or update.
expireAt(K, long) - Method in class org.cache2k.AbstractCache
expireAt(K, long) - Method in interface org.cache2k.Cache: Updates an existing not expired mapping to expire at the given point in time.
expireAt(K, long) - Method in class org.cache2k.ForwardingCache
Expiry - Class in org.cache2k.expiry: Utility methods and constants to use inside expire policy or resilience policy.
Expiry() - Constructor for class org.cache2k.expiry.Expiry
EXPIRY_ETERNAL - Static variable in class org.cache2k.config.Cache2kConfig: A marker duration used in Cache2kConfig.setExpireAfterWrite(Duration), to request eternal expiry.
expiryPolicy(ExpiryPolicy<? super K, ? super 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.
extract(Cache2kBuilder<?, ?>, Class<T>) - Static method in class org.cache2k.config.ToggleFeature: Returns the feature instance, if present.

F

Feature - Interface in org.cache2k.config: Features need to properly implement equals() and hashCode()
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.
ForwardingCache<K,V> - Class in org.cache2k: Wrapper class that forwards all method calls to a delegate.
ForwardingCache() - Constructor for class org.cache2k.ForwardingCache

G

generateExceptionToPropagate() - Method in interface org.cache2k.io.LoadExceptionInfo: Generate the exception to propagate with the exception propagator
get(K) - Method in class org.cache2k.AbstractCache
get(K) - Method in interface org.cache2k.Cache: Returns a value associated with the given key.
get(K) - Method in class org.cache2k.ForwardingCache
get(K) - Method in interface org.cache2k.KeyValueSource: Returns a value associated with this key.
getActiveCaches() - Method in class org.cache2k.CacheManager: Returns all open caches associated with this cache manager.
getAdvancedLoader() - Method in class org.cache2k.config.Cache2kConfig
getAll(Iterable<? extends K>) - Method in class org.cache2k.AbstractCache
getAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Retrieve values from the cache associated with the provided keys.
getAll(Iterable<? extends K>) - Method in class org.cache2k.ForwardingCache
getAsyncListenerExecutor() - Method in class org.cache2k.config.Cache2kConfig
getAsyncListeners() - Method in class org.cache2k.config.Cache2kConfig: A set of listeners.
getAsyncLoader() - Method in class org.cache2k.config.Cache2kConfig
getCache() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext: Cache originating the request
getCache() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: The cache originating the load request
getCache(String) - Method in class org.cache2k.CacheManager: Return a known cache that must be created before via the Cache2kBuilder or CacheManager.createCache(Cache2kConfig)
getCacheExpiryTime() - Method in interface org.cache2k.expiry.ValueWithExpiryTime: Point in time in milliseconds when the value should expire.
getCacheManager() - Method in class org.cache2k.AbstractCache
getCacheManager() - Method in interface org.cache2k.Cache: Return the cache manager for this cache instance.
getCacheManager() - Method in interface org.cache2k.config.CacheBuildContext: Assigned cache manager.
getCacheManager() - Method in class org.cache2k.ForwardingCache
getCacheWrapper() - Method in class org.cache2k.config.Cache2kConfig
getCallback() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext
getCapacityLimit() - Method in interface org.cache2k.operation.CacheInfo: Either CacheInfo.getMaximumWeight() or CacheInfo.getEntryCapacity() depending on whether a weigher is present or not.
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.config.CustomizationSupplierByClassName
getClearCallsCount() - Method in interface org.cache2k.operation.CacheStatistics: Number of Cache.clear() invocations.
getClearedCount() - Method in interface org.cache2k.operation.CacheStatistics: Number entries removed from the cache by the Cache.clear() operation.
getClearedTime() - Method in interface org.cache2k.operation.CacheInfo: Time of the most recent Cache.clear() operation.
getComponentType() - Method in interface org.cache2k.config.CacheType: The component type in case of an array
getComponentType() - Method in class org.cache2k.config.CacheTypeCapture
getComponentType() - Method in class org.cache2k.config.CacheTypeCapture.OfArray
getConfig() - Method in interface org.cache2k.config.CacheBuildContext: The effective cache configuration.
getConfigClass() - Method in interface org.cache2k.config.WithSection
getConfiguredCacheNames() - Method in class org.cache2k.CacheManager: Returns a list of caches that are found in the XML based configuration.
getContextMap() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext: Individual load context for each key.
getCreatedTime() - Method in interface org.cache2k.operation.CacheInfo: Time when the cache was created.
getCurrentEntry() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: Current entry in the cache.
getDefaultClassLoader() - Method in interface org.cache2k.spi.Cache2kCoreProvider: Default class loader, this is the class loader used to load the cache implementation.
getDefaultConfig(CacheManager) - Method in interface org.cache2k.spi.Cache2kCoreProvider: Return the effective default configuration for this manager.
getDefaultManagerName() - Method in class org.cache2k.config.Cache2kManagerConfig
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 class org.cache2k.AbstractCache
getEntry(K) - Method in interface org.cache2k.Cache: Returns an entry that contains the cache value associated with the given key.
getEntry(K) - Method in class org.cache2k.ForwardingCache
getEntryCapacity() - Method in class org.cache2k.config.Cache2kConfig
getEntryCapacity() - Method in interface org.cache2k.operation.CacheInfo: The configured maximum number of entries in the cache.
getEvictedCount() - Method in interface org.cache2k.operation.CacheStatistics: An entry was evicted from the cache because of size limits.
getEvictedOrRemovedWeight() - Method in interface org.cache2k.operation.CacheStatistics: Accumulated number of weight evicted or removed entries
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.io.LoadExceptionInfo: The original exception generated by the last recent loader call.
getException() - Method in interface org.cache2k.processor.EntryProcessingResult: Original exception from entry processing or null if no exception occurred.
getException() - Method in interface org.cache2k.processor.MutableCacheEntry: The exception happened when the value was loaded and the exception could not be suppressed.
getExceptionInfo() - Method in interface org.cache2k.CacheEntry: Detailed information of the latest exception from the loader.
getExceptionInfo() - Method in interface org.cache2k.io.LoadExceptionInfo: Returns ourselves.
getExceptionInfo() - Method in interface org.cache2k.processor.MutableCacheEntry: Detailed information of the latest exception from the loader.
getExceptionPropagator() - Method in class org.cache2k.config.Cache2kConfig
getExceptionPropagator() - Method in interface org.cache2k.io.LoadExceptionInfo: The exception propagator in effect.
getExecutor() - Method in class org.cache2k.config.Cache2kConfig
getExecutor() - Method in interface org.cache2k.config.CacheBuildContext: Executor to use for this cache instance.
getExecutor() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext: The configured executor for async operations.
getExecutor() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: The configured executor for async operations.
getExpireAfterWrite() - Method in class org.cache2k.config.Cache2kConfig
getExpiredCount() - Method in interface org.cache2k.operation.CacheStatistics: A cache entry has expired.
getExpiryAfterWriteTicks() - Method in interface org.cache2k.operation.CacheInfo: Configured Cache2kBuilder.expireAfterWrite(Duration) or Long.MAX_VALUE if no expiry.
getExpiryPolicy() - Method in class org.cache2k.config.Cache2kConfig
getExpiryTime() - Method in interface org.cache2k.processor.MutableCacheEntry: Returns the effective expiry time of the current cache entry in case MutableCacheEntry.exists() is false it returnsExpiryTimeValues.NOW.
getFeatures() - Method in class org.cache2k.config.Cache2kConfig
getGetCount() - Method in interface org.cache2k.operation.CacheStatistics: How often data was requested from the cache.
getHitRate() - Method in interface org.cache2k.operation.CacheStatistics: The percentage of cache accesses the cache delivered data.
getIdleScanTime() - Method in class org.cache2k.config.Cache2kConfig
getImplementation() - Method in interface org.cache2k.operation.CacheInfo: Descriptor of cache implementation in use.
getInsertCount() - Method in interface org.cache2k.operation.CacheStatistics: How many times a new entry was inserted into the cache.
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(ClassLoader, String) - Static method in class org.cache2k.CacheManager: Retrieve a cache manager with the specified name using the specified classloader.
getInstance(String) - Static method in class org.cache2k.CacheManager: Retrieve a cache manager with the specified name.
getKey() - Method in interface org.cache2k.CacheEntry: Key associated with this entry.
getKey() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: Cache key for the load request.
getKey() - Method in interface org.cache2k.io.LoadExceptionInfo: The key of the entry.
getKeyMutationCount() - Method in interface org.cache2k.operation.CacheStatistics: Number of key mutations occurred.
getKeys() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext: Keys requested to load.
getKeyType() - Method in class org.cache2k.config.Cache2kConfig
getKeyType() - Method in interface org.cache2k.operation.CacheInfo: Type of the cache key.
getLifecycleListeners() - Method in class org.cache2k.config.Cache2kConfig: A set of listeners.
getListeners() - Method in class org.cache2k.config.Cache2kConfig: A set of listeners.
getLoadCount() - Method in interface org.cache2k.operation.CacheStatistics: How many times a load succeeded.
getLoader() - Method in class org.cache2k.config.Cache2kConfig
getLoaderExecutor() - Method in class org.cache2k.config.Cache2kConfig
getLoaderExecutor() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext: The configured loader executor.
getLoaderExecutor() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: The configured loader executor.
getLoaderThreadCount() - Method in class org.cache2k.config.Cache2kConfig
getLoadExceptionCount() - Method in interface org.cache2k.operation.CacheStatistics: Number of exceptions thrown by the CacheLoader.
getLoadTime() - Method in interface org.cache2k.io.LoadExceptionInfo: Start time of the load operation that generated the recent exception.
getManager() - Method in class org.cache2k.Cache2kBuilder: Get the associated cache manager.
getManager(ClassLoader, String) - Method in interface org.cache2k.spi.Cache2kCoreProvider
getManagerName() - Method in interface org.cache2k.operation.CacheInfo
getMaximumWeight() - Method in class org.cache2k.config.Cache2kConfig
getMaximumWeight() - Method in interface org.cache2k.operation.CacheInfo: Configured maximum weight or -1.
getMillisPerLoad() - Method in interface org.cache2k.operation.CacheStatistics: Average number of milliseconds per load.
getMissCount() - Method in interface org.cache2k.operation.CacheStatistics: Counter of the event that: a client requested a data which was not present in the cache or had expired.
getModificationTime() - Method in interface org.cache2k.processor.MutableCacheEntry: Time of the last update of the cached value.
getName() - Method in class org.cache2k.AbstractCache
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.config.Cache2kConfig
getName() - Method in interface org.cache2k.config.CacheBuildContext: The cache name.
getName() - Method in class org.cache2k.ForwardingCache
getName() - Method in interface org.cache2k.operation.CacheInfo
getProperties() - Method in class org.cache2k.CacheManager: Properties for the cache manager, never null.
getPutCount() - Method in interface org.cache2k.operation.CacheStatistics: The total number of insert or update operations.
getRefreshCount() - Method in interface org.cache2k.operation.CacheStatistics: Refreshed entries counter.
getRefreshedHitCount() - Method in interface org.cache2k.operation.CacheStatistics: How many times there was a hit on a refreshed entry.
getRefreshExecutor() - Method in class org.cache2k.config.Cache2kConfig
getRefreshFailedCount() - Method in interface org.cache2k.operation.CacheStatistics: Counter how many times a refresh failed, e.g.
getRemoveCount() - Method in interface org.cache2k.operation.CacheStatistics: Number of remove operations.
getResiliencePolicy() - Method in class org.cache2k.config.Cache2kConfig
getResult() - Method in interface org.cache2k.processor.EntryProcessingResult: Result of entry processing.
getRetryCount() - Method in interface org.cache2k.io.LoadExceptionInfo: Number of retry attempts to load the value for the requested key.
getScheduler() - Method in class org.cache2k.config.Cache2kConfig
getSection(Class<T>) - Method in class org.cache2k.config.SectionContainer
getSection(Class<T>, T) - Method in class org.cache2k.config.SectionContainer: Retrieve a single section from the container.
getSections() - Method in class org.cache2k.config.Cache2kConfig: Mutable collection of additional configuration sections
getSections() - Method in interface org.cache2k.config.ConfigWithSections
getSinceTime() - Method in interface org.cache2k.io.LoadExceptionInfo: Start time of the load that generated the first exception.
getSize() - Method in interface org.cache2k.operation.CacheInfo: The current number of entries within the cache, starting with 0.
getStartTime() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext
getStartTime() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: Start of load operation
getStartTime() - Method in interface org.cache2k.processor.MutableCacheEntry: Time the operation started.
getSuppressedLoadExceptionCount() - Method in interface org.cache2k.operation.CacheStatistics: Number of exceptions thrown by the CacheLoader that were ignored and the previous data value got returned.
getTimeReference() - Method in class org.cache2k.config.Cache2kConfig
getTimeReference() - Method in interface org.cache2k.config.CacheBuildContext: Time reference to use for this cache instance.
getTimeReference() - Method in interface org.cache2k.operation.CacheInfo: Effective time reference
getTimerLag() - Method in class org.cache2k.config.Cache2kConfig
getTotalLoadMillis() - Method in interface org.cache2k.operation.CacheStatistics: Total number of time spent loading entries from the cache loader.
getTotalWeight() - Method in interface org.cache2k.operation.CacheInfo: Total weight of all entries in the cache.
getTraceCacheWrapper() - Method in class org.cache2k.config.Cache2kConfig
getType() - Method in interface org.cache2k.config.CacheType: Class type if not an array.
getType() - Method in class org.cache2k.config.CacheTypeCapture
getType() - Method in class org.cache2k.config.CacheTypeCapture.OfClass
getType() - Method in class org.cache2k.config.CacheTypeCapture.OfGeneric
getTypeArguments() - Method in interface org.cache2k.config.CacheType: Known type arguments, if the type is a parametrized type.
getTypeArguments() - Method in class org.cache2k.config.CacheTypeCapture
getTypeArguments() - Method in class org.cache2k.config.CacheTypeCapture.OfGeneric
getTypeName() - Method in interface org.cache2k.config.CacheType: Java language compatible type name
getTypeName() - Method in class org.cache2k.config.CacheTypeCapture
getTypeName() - Method in class org.cache2k.config.CacheTypeCapture.OfArray
getTypeName() - Method in class org.cache2k.config.CacheTypeCapture.OfClass
getTypeName() - Method in class org.cache2k.config.CacheTypeCapture.OfGeneric
getUntil() - Method in interface org.cache2k.io.LoadExceptionInfo: 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.io.LoadExceptionInfo: Always throws exception based on exception propagator semantics.
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.config.Cache2kConfig
getValueType() - Method in interface org.cache2k.operation.CacheInfo: Type of the cache value.
getVersion() - Method in class org.cache2k.config.Cache2kManagerConfig
getVersion() - Method in interface org.cache2k.spi.Cache2kCoreProvider
getWeigher() - Method in class org.cache2k.config.Cache2kConfig
getWriter() - Method in class org.cache2k.config.Cache2kConfig

H

hasAsyncListeners() - Method in class org.cache2k.config.Cache2kConfig
hasFeatures() - Method in class org.cache2k.config.Cache2kConfig
hashCode() - Method in class org.cache2k.config.CacheTypeCapture
hashCode() - Method in class org.cache2k.config.CacheTypeCapture.OfArray
hashCode() - Method in class org.cache2k.config.CacheTypeCapture.OfClass
hashCode() - Method in class org.cache2k.config.CacheTypeCapture.OfGeneric
hashCode() - Method in class org.cache2k.config.CustomizationReferenceSupplier
hashCode() - Method in class org.cache2k.config.CustomizationSupplierByClassName
hashCode() - Method in class org.cache2k.config.ToggleFeature: Hashcode from the implementation class.
hasLifecycleListeners() - Method in class org.cache2k.config.Cache2kConfig
hasListeners() - Method in class org.cache2k.config.Cache2kConfig
hasTypeArguments() - Method in interface org.cache2k.config.CacheType: The type has generic type parameters and the concrete types are known.
hasTypeArguments() - Method in class org.cache2k.config.CacheTypeCapture
hasTypeArguments() - Method in class org.cache2k.config.CacheTypeCapture.OfGeneric

I

idleScanTime(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder
idleScanTime(Duration) - Method in class org.cache2k.Cache2kBuilder: Sets the time for a regular scan of all cache entries which evicts idle entries that are not accessed since the last scan.
invoke(K, EntryProcessor<K, V, R>) - Method in class org.cache2k.AbstractCache
invoke(K, EntryProcessor<K, V, R>) - Method in interface org.cache2k.Cache: Invoke a user defined function on a cache entry.
invoke(K, EntryProcessor<K, V, R>) - Method in class org.cache2k.ForwardingCache
invokeAll(Iterable<? extends K>, EntryProcessor<K, V, R>) - Method in class org.cache2k.AbstractCache
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.
invokeAll(Iterable<? extends K>, EntryProcessor<K, V, R>) - Method in class org.cache2k.ForwardingCache
isArray() - Method in interface org.cache2k.config.CacheType: This type is an array.
isArray() - Method in class org.cache2k.config.CacheTypeCapture
isArray() - Method in class org.cache2k.config.CacheTypeCapture.OfArray
isBoostConcurrency() - Method in class org.cache2k.config.Cache2kConfig
isClosed() - Method in class org.cache2k.AbstractCache
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.
isClosed() - Method in class org.cache2k.ForwardingCache
isDefaultManager() - Method in class org.cache2k.CacheManager: True if this is the default manager of the application, returned by CacheManager.getInstance()
isDisableMonitoring() - Method in class org.cache2k.config.Cache2kConfig
isDisableStatistics() - Method in class org.cache2k.config.Cache2kConfig
isEnabled() - Method in class org.cache2k.config.ToggleFeature
isEnabled(Cache2kBuilder<?, ?>, Class<? extends ToggleFeature>) - Static method in class org.cache2k.config.ToggleFeature: Returns true if the feature is enabled.
isEternal() - Method in class org.cache2k.config.Cache2kConfig
isExternalConfigurationPresent() - Method in class org.cache2k.config.Cache2kConfig: An external configuration for the cache was found and is applied.
isIgnoreAnonymousCache() - Method in class org.cache2k.config.Cache2kManagerConfig
isIgnoreMissingCacheConfiguration() - Method in class org.cache2k.config.Cache2kManagerConfig
isKeepDataAfterExpired() - Method in class org.cache2k.config.Cache2kConfig
isLoaderPresent() - Method in interface org.cache2k.operation.CacheInfo: A loader is configured.
isNameWasGenerated() - Method in class org.cache2k.config.Cache2kConfig: True if name is generated and not set by the cache client.
isPermitNullValues() - Method in class org.cache2k.config.Cache2kConfig
isRecordModificationTime() - Method in class org.cache2k.config.Cache2kConfig
isRefreshAhead() - Method in class org.cache2k.config.Cache2kConfig
isRefreshAhead() - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext: Operation is refresh and not a client request.
isRefreshAhead() - Method in interface org.cache2k.io.AsyncCacheLoader.Context: Operation is refresh and not an immediate client request.
isSharpExpiry() - Method in class org.cache2k.config.Cache2kConfig
isSkipCheckOnStartup() - Method in class org.cache2k.config.Cache2kManagerConfig
isStatisticsEnabled() - Method in interface org.cache2k.operation.CacheInfo: This cache supports statistics.
isStoreByReference() - Method in class org.cache2k.config.Cache2kConfig
isStrictEviction() - Method in class org.cache2k.config.Cache2kConfig
isWeigherPresent() - Method in interface org.cache2k.operation.CacheInfo: A weigher is configured.
iterator() - Method in class org.cache2k.config.SectionContainer

K

keepDataAfterExpired(boolean) - Method in class org.cache2k.Cache2kBuilder: Expired data is kept in the cache until the entry is evicted.
keys() - Method in class org.cache2k.AbstractCache
keys() - Method in interface org.cache2k.Cache: A set view of all keys in the cache.
keys() - Method in class org.cache2k.ForwardingCache
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.

L

load() - Method in interface org.cache2k.processor.MutableCacheEntry: Calls the loader unconditionally in this operation.
load(K) - Method in interface org.cache2k.io.BulkCacheLoader: By default uses BulkCacheLoader.loadAll(java.util.Set<? extends K>) to load a singe value.
load(K) - Method in interface org.cache2k.io.CacheLoader: Retrieves or generates data based on the key.
load(K, long, CacheEntry<K, V>) - Method in interface org.cache2k.io.AdvancedCacheLoader: Retrieves or generates data based on the key parameter.
load(K, AsyncCacheLoader.Context<K, V>, AsyncCacheLoader.Callback<V>) - Method in interface org.cache2k.io.AsyncBulkCacheLoader: By default loads a single value via AsyncBulkCacheLoader.loadAll(java.util.Set<K>, org.cache2k.io.AsyncBulkCacheLoader.BulkLoadContext<K, V>, org.cache2k.io.AsyncBulkCacheLoader.BulkCallback<K, V>).
load(K, AsyncCacheLoader.Context<K, V>, AsyncCacheLoader.Callback<V>) - Method in interface org.cache2k.io.AsyncCacheLoader: Starts an asynchronous load operation.
loadAll(Iterable<? extends K>) - Method in class org.cache2k.AbstractCache
loadAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Request to load the given set of keys into the cache.
loadAll(Iterable<? extends K>) - Method in class org.cache2k.ForwardingCache
loadAll(Set<? extends K>) - Method in interface org.cache2k.io.BulkCacheLoader: Load all data referenced by the key set.
loadAll(Set<K>, AsyncBulkCacheLoader.BulkLoadContext<K, V>, AsyncBulkCacheLoader.BulkCallback<K, V>) - Method in interface org.cache2k.io.AsyncBulkCacheLoader: Load all values referenced by the key set.
loader(AdvancedCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder: Enables read through operation and sets a cache loader.
loader(AsyncCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder: Enables read through operation and sets a cache loader.
loader(CacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder: Enables read through operation and sets a cache loader.
loaderExecutor(Executor) - Method in class org.cache2k.Cache2kBuilder: Thread pool / executor service to use for triggered 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.
LoadExceptionInfo<K,V> - Interface in org.cache2k.io: Relevant information of a load attempt that generated an exception.
lock() - Method in interface org.cache2k.processor.MutableCacheEntry: Locks the entry for mutation.

M

manager(CacheManager) - Method in class org.cache2k.Cache2kBuilder: The manager, the created cache will belong to.
maximumWeight(long) - Method in class org.cache2k.Cache2kBuilder: Specifies the maximum weight of entries the cache may contain.
Milliseconds() - Constructor for class org.cache2k.operation.TimeReference.Milliseconds
MINIMUM_TICKS - Static variable in interface org.cache2k.operation.TimeReference: Every time reference is expected to produce times higher or equal to this value.
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.
mutate(K, EntryMutator<K, V>) - Method in class org.cache2k.AbstractCache
mutate(K, EntryMutator<K, V>) - Method in interface org.cache2k.Cache: Invoke a user defined operation on a cache entry.
mutate(K, EntryMutator<K, V>) - Method in class org.cache2k.ForwardingCache
mutate(MutableCacheEntry<K, V>) - Method in interface org.cache2k.processor.EntryMutator
mutateAll(Iterable<? extends K>, EntryMutator<K, V>) - Method in class org.cache2k.AbstractCache
mutateAll(Iterable<? extends K>, EntryMutator<K, V>) - Method in interface org.cache2k.Cache: Invoke a user defined mutation operation on multiple cache entries specified by the keys parameter.
mutateAll(Iterable<? extends K>, EntryMutator<K, V>) - Method in class org.cache2k.ForwardingCache

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<?>) - Method in class org.cache2k.Cache2kBuilder: Sets a cache name from the fully qualified class name.
name(Class<?>, String) - Method in class org.cache2k.Cache2kBuilder: Constructs a cache name out of the class name and field 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.
NonNull - Annotation Type in org.cache2k.annotation: Non-null is the default.
NonNullApi - Annotation Type in org.cache2k.annotation: Sets the convention to not null parameters and return values on a package level (Non-null except locals).
NOW - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: The value expires immediately and will not be cached.
Nullable - Annotation Type in org.cache2k.annotation: The annotated element can be null under some circumstance.

O

of(Class<K>, Class<V>) - Static method in class org.cache2k.Cache2kBuilder: Create a new cache builder for key and value types of classes with no generic parameters.
of(Class<K>, Class<V>) - Static method in class org.cache2k.config.Cache2kConfig: Construct a config instance setting the type parameters and returning a proper generic type.
of(Class<T>) - Static method in interface org.cache2k.config.CacheType
of(Type) - Static method in interface org.cache2k.config.CacheType
of(Cache<?, ?>) - Static method in interface org.cache2k.operation.CacheControl: Request the management interface of the given cache.
of(Cache<?, ?>) - Static method in interface org.cache2k.operation.CacheInfo: Request an instance for the given cache.
of(Cache2kConfig<K, V>) - Static method in class org.cache2k.Cache2kBuilder: Create a builder from the configuration bean.
of(CacheType<K>, CacheType<V>) - Static method in class org.cache2k.config.Cache2kConfig: Construct a config instance setting the type parameters and returning a proper generic type.
OfArray(CacheType<?>) - Constructor for class org.cache2k.config.CacheTypeCapture.OfArray
OfClass(Class<T>) - Constructor for class org.cache2k.config.CacheTypeCapture.OfClass
OfGeneric(Class<T>, CacheType<?>[]) - Constructor for class org.cache2k.config.CacheTypeCapture.OfGeneric
onCacheClosed(Cache<?, ?>) - Method in interface org.cache2k.event.CacheClosedListener: Called when cache is closed.
onCacheCreated(Cache<K, V>, CacheBuildContext<K, V>) - Method in interface org.cache2k.event.CacheCreatedListener: A new cache has been created.
onEntryCreated(Cache<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.event.CacheEntryCreatedListener: Called for the creation of a cache entry and after all cache writers ran successfully.
onEntryEvicted(Cache<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.event.CacheEntryEvictedListener: Called upon eviction of a cache entry.
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.
onLoadFailure(Iterable<? extends K>, Throwable) - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkCallback: Report exception for a set of keys.
onLoadFailure(Throwable) - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkCallback: The load attempt resulted in an exception.
onLoadFailure(Throwable) - Method in interface org.cache2k.io.AsyncCacheLoader.Callback: Called if a failure happened.
onLoadFailure(K, Throwable) - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkCallback: Report exception for a specific key.
onLoadSuccess(Map<? extends K, ? extends V>) - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkCallback: The load was successful.
onLoadSuccess(K, V) - Method in interface org.cache2k.io.AsyncBulkCacheLoader.BulkCallback: A single key value tuple was loaded successfully.
onLoadSuccess(V) - Method in interface org.cache2k.io.AsyncCacheLoader.Callback: Called to provide the loaded value to be stored in the cache.
org.cache2k - package org.cache2k: Main package for cache2k API containing functions to build and access a cache.
org.cache2k.annotation - package org.cache2k.annotation: Containing NonNull and Nullable annotations.
org.cache2k.config - package org.cache2k.config: 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.io - package org.cache2k.io: Loader and writer to integrate with external data sources.
org.cache2k.operation - package org.cache2k.operation: Operational aspects of a cache, like accessing statistics, basic information, change runtime parameters and customizations that augment general behavior.
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 class org.cache2k.AbstractCache
peek(K) - Method in interface org.cache2k.Cache: Returns the value associated to the given key.
peek(K) - Method in class org.cache2k.ForwardingCache
peekAll(Iterable<? extends K>) - Method in class org.cache2k.AbstractCache
peekAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Bulk version for Cache.peek(Object)
peekAll(Iterable<? extends K>) - Method in class org.cache2k.ForwardingCache
peekAndPut(K, V) - Method in class org.cache2k.AbstractCache
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.
peekAndPut(K, V) - Method in class org.cache2k.ForwardingCache
peekAndRemove(K) - Method in class org.cache2k.AbstractCache
peekAndRemove(K) - Method in interface org.cache2k.Cache: Removes the mapping for a key from the cache if it is present.
peekAndRemove(K) - Method in class org.cache2k.ForwardingCache
peekAndReplace(K, V) - Method in class org.cache2k.AbstractCache
peekAndReplace(K, V) - Method in interface org.cache2k.Cache: Replaces the entry for a key only if currently mapped to some value.
peekAndReplace(K, V) - Method in class org.cache2k.ForwardingCache
peekEntry(K) - Method in class org.cache2k.AbstractCache
peekEntry(K) - Method in interface org.cache2k.Cache: Returns an entry that contains the cache value associated with the given key.
peekEntry(K) - Method in class org.cache2k.ForwardingCache
permitNullValues(boolean) - Method in class org.cache2k.Cache2kBuilder: When true, null values are allowed in the cache.
process(MutableCacheEntry<K, V>) - Method in interface org.cache2k.processor.EntryProcessor: Examines or mutates an entry.
propagateException(LoadExceptionInfo<K, V>) - Method in interface org.cache2k.io.ExceptionPropagator: Called when an entry value with exception is accessed.
PROVIDER - Static variable in class org.cache2k.CacheManager: The singleton cache provider instance.
put(K, V) - Method in class org.cache2k.AbstractCache
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 class org.cache2k.ForwardingCache
putAll(Map<? extends K, ? extends V>) - Method in class org.cache2k.AbstractCache
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 class org.cache2k.ForwardingCache
putIfAbsent(K, V) - Method in class org.cache2k.AbstractCache
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.
putIfAbsent(K, V) - Method in class org.cache2k.ForwardingCache

R

recordModificationTime(boolean) - Method in class org.cache2k.Cache2kBuilder: Enables that time of an update (e.g.
REFRESH - Static variable in interface org.cache2k.expiry.ExpiryTimeValues: Expires the entry and starts a refresh if Cache2kBuilder.refreshAhead(boolean) is enabled.
refreshAhead(boolean) - Method in class org.cache2k.Cache2kBuilder: When true, enable background refresh / refresh ahead.
refreshExecutor(Executor) - Method in class org.cache2k.Cache2kBuilder: Thread pool / executor service to use for refresh ahead operations.
reloadAll(Iterable<? extends K>) - Method in class org.cache2k.AbstractCache
reloadAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Request to load the given set of keys into the cache.
reloadAll(Iterable<? extends K>) - Method in class org.cache2k.ForwardingCache
remove() - Method in interface org.cache2k.processor.MutableCacheEntry: Removes an entry from the cache.
remove(K) - Method in class org.cache2k.AbstractCache
remove(K) - Method in interface org.cache2k.Cache: Removes the mapping for a key from the cache if it is present.
remove(K) - Method in class org.cache2k.ForwardingCache
removeAll() - Method in class org.cache2k.AbstractCache
removeAll() - Method in interface org.cache2k.Cache: Removes all cache contents.
removeAll() - Method in class org.cache2k.ForwardingCache
removeAll() - Method in interface org.cache2k.operation.CacheOperation: Removes all cache contents.
removeAll(Iterable<? extends K>) - Method in class org.cache2k.AbstractCache
removeAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache: Removes a set of keys.
removeAll(Iterable<? extends K>) - Method in class org.cache2k.ForwardingCache
removeIfEquals(K, V) - Method in class org.cache2k.AbstractCache
removeIfEquals(K, V) - Method in interface org.cache2k.Cache: Remove the mapping if the stored value is equal to the comparison value.
removeIfEquals(K, V) - Method in class org.cache2k.ForwardingCache
replace(K, V) - Method in class org.cache2k.AbstractCache
replace(K, V) - Method in interface org.cache2k.Cache: Replaces the entry for a key only if currently mapped to some value.
replace(K, V) - Method in class org.cache2k.ForwardingCache
replaceIfEquals(K, V, V) - Method in class org.cache2k.AbstractCache
replaceIfEquals(K, V, V) - Method in interface org.cache2k.Cache: Replaces the entry for a key only if currently mapped to a given value.
replaceIfEquals(K, V, V) - Method in class org.cache2k.ForwardingCache
requestInterface(Class<T>) - Method in interface org.cache2k.Cache: Request an alternative interface for this cache instance.
requestInterface(Class<X>) - Method in class org.cache2k.AbstractCache
requestInterface(Class<X>) - Method in class org.cache2k.ForwardingCache
resiliencePolicy(CustomizationSupplier<? extends ResiliencePolicy<? super K, ? super V>>) - Method in class org.cache2k.Cache2kBuilder
resiliencePolicy(ResiliencePolicy<? super K, ? super 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> - Interface in org.cache2k.io: Controls how to deal with loader exceptions in a read through configuration.
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: Used for internal flow control, no need to carry a message or stack trace.
retryLoadAfter(K, LoadExceptionInfo<K, V>) - Method in interface org.cache2k.io.ResiliencePolicy: Called after the loader threw an exception and no previous value is available or ResiliencePolicy.suppressExceptionUntil(K, org.cache2k.io.LoadExceptionInfo<K, V>, org.cache2k.CacheEntry<K, V>) returned zero.

S

sampleStatistics() - Method in interface org.cache2k.operation.CacheControl: Returns a snapshot of cache statistics if this cache supports statistics or null otherwise.
schedule(Runnable, long) - Method in interface org.cache2k.operation.Scheduler: Schedule the task to be run after a given delay.
scheduler(Scheduler) - Method in class org.cache2k.Cache2kBuilder: Use a different scheduler to run timer tasks for.
Scheduler - Interface in org.cache2k.operation: Scheduler to run timer tasks, e.g.
SectionBuilder<SELF extends SectionBuilder<SELF,T>,T extends ConfigSection<T,SELF>> - Interface in org.cache2k.config: Supports adding configuration sections via the builder pattern.
SectionContainer - Class in org.cache2k.config: Container for configuration objects.
SectionContainer() - Constructor for class org.cache2k.config.SectionContainer
set(Consumer<Cache2kConfig<K, V>>) - Method in class org.cache2k.Cache2kBuilder: Execute on the underlying configuration object.
setAdvancedLoader(CustomizationSupplier<? extends AdvancedCacheLoader<K, V>>) - Method in class org.cache2k.config.Cache2kConfig
setAsyncListenerExecutor(CustomizationSupplier<? extends Executor>) - Method in class org.cache2k.config.Cache2kConfig
setAsyncListeners(Collection<CustomizationSupplier<CacheEntryOperationListener<K, V>>>) - Method in class org.cache2k.config.Cache2kConfig: Adds the collection of customizations to the existing list.
setAsyncLoader(CustomizationSupplier<? extends AsyncCacheLoader<K, V>>) - Method in class org.cache2k.config.Cache2kConfig
setBoostConcurrency(boolean) - Method in class org.cache2k.config.Cache2kConfig
setCacheWrapper(CacheWrapper) - Method in class org.cache2k.config.Cache2kConfig
setClassName(String) - Method in class org.cache2k.config.CustomizationSupplierByClassName
setDefaultManagerName(ClassLoader, String) - Method in interface org.cache2k.spi.Cache2kCoreProvider
setDefaultManagerName(String) - Method in class org.cache2k.config.Cache2kManagerConfig: Replace the default name of the default cache manager.
setDefaultName(String) - Static method in class org.cache2k.CacheManager: Change the default manager name.
setDisableMonitoring(boolean) - Method in class org.cache2k.config.Cache2kConfig
setDisableStatistics(boolean) - Method in class org.cache2k.config.Cache2kConfig
setEnable(boolean) - Method in class org.cache2k.config.ToggleFeature: Alternate setter for spelling flexibility in XML configuration.
setEnabled(boolean) - Method in class org.cache2k.config.ToggleFeature
setEntryCapacity(long) - Method in class org.cache2k.config.Cache2kConfig
setEternal(boolean) - Method in class org.cache2k.config.Cache2kConfig
setException(Throwable) - Method in interface org.cache2k.processor.MutableCacheEntry: Insert or update the entry and sets an exception.
setExceptionPropagator(CustomizationSupplier<? extends ExceptionPropagator<? super K, ? super V>>) - Method in class org.cache2k.config.Cache2kConfig
setExecutor(CustomizationSupplier<? extends Executor>) - Method in class org.cache2k.config.Cache2kConfig
setExpireAfterWrite(Duration) - Method in class org.cache2k.config.Cache2kConfig: Sets expire after write.
setExpiryPolicy(CustomizationSupplier<? extends ExpiryPolicy<? super K, ? super V>>) - Method in class org.cache2k.config.Cache2kConfig
setExpiryTime(long) - Method in interface org.cache2k.processor.MutableCacheEntry: Set a new expiry time for the entry.
setExternalConfigurationPresent(boolean) - Method in class org.cache2k.config.Cache2kConfig
setFeatures(Set<? extends Feature>) - Method in class org.cache2k.config.Cache2kConfig
setIdleScanTime(Duration) - Method in class org.cache2k.config.Cache2kConfig
setIgnoreAnonymousCache(boolean) - Method in class org.cache2k.config.Cache2kManagerConfig: When a configuration is present, every cache needs a cache name so that the configuration can be applied.
setIgnoreMissingCacheConfiguration(boolean) - Method in class org.cache2k.config.Cache2kManagerConfig: Configure a cache with default parameters if configuration has no specific section for it.
setKeepDataAfterExpired(boolean) - Method in class org.cache2k.config.Cache2kConfig
setKeyType(CacheType<K>) - Method in class org.cache2k.config.Cache2kConfig
setLifecycleListeners(Collection<CustomizationSupplier<? extends CacheLifecycleListener>>) - Method in class org.cache2k.config.Cache2kConfig: Adds the collection of customizations to the existing list.
setListeners(Collection<CustomizationSupplier<CacheEntryOperationListener<K, V>>>) - Method in class org.cache2k.config.Cache2kConfig: Adds the collection of customizations to the existing list.
setLoader(CustomizationSupplier<? extends CacheLoader<K, V>>) - Method in class org.cache2k.config.Cache2kConfig
setLoaderExecutor(CustomizationSupplier<? extends Executor>) - Method in class org.cache2k.config.Cache2kConfig
setLoaderThreadCount(int) - Method in class org.cache2k.config.Cache2kConfig
setMaximumWeight(long) - Method in class org.cache2k.config.Cache2kConfig
setModificationTime(long) - Method in interface org.cache2k.processor.MutableCacheEntry: If MutableCacheEntry.setValue(Object) is used, this sets an alternative time for expiry calculations.
setName(String) - Method in class org.cache2k.config.Cache2kConfig
setNameWasGenerated(boolean) - Method in class org.cache2k.config.Cache2kConfig
setPermitNullValues(boolean) - Method in class org.cache2k.config.Cache2kConfig
setRecordModificationTime(boolean) - Method in class org.cache2k.config.Cache2kConfig
setRefreshAhead(boolean) - Method in class org.cache2k.config.Cache2kConfig
setRefreshExecutor(CustomizationSupplier<? extends Executor>) - Method in class org.cache2k.config.Cache2kConfig
setResiliencePolicy(CustomizationSupplier<? extends ResiliencePolicy<? super K, ? super V>>) - Method in class org.cache2k.config.Cache2kConfig
setScheduler(CustomizationSupplier<? extends Scheduler>) - Method in class org.cache2k.config.Cache2kConfig
setSections(Collection<ConfigSection<?, ?>>) - Method in class org.cache2k.config.Cache2kConfig: Adds the collection of sections to the existing list.
setSharpExpiry(boolean) - Method in class org.cache2k.config.Cache2kConfig
setSkipCheckOnStartup(boolean) - Method in class org.cache2k.config.Cache2kManagerConfig: The configuration for each cache is parsed and checked as soon as the cache manager is created.
setStoreByReference(boolean) - Method in class org.cache2k.config.Cache2kConfig
setStrictEviction(boolean) - Method in class org.cache2k.config.Cache2kConfig
setTimeReference(CustomizationSupplier<? extends TimeReference>) - Method in class org.cache2k.config.Cache2kConfig
setTimerLag(Duration) - Method in class org.cache2k.config.Cache2kConfig
setTraceCacheWrapper(CacheWrapper) - Method in class org.cache2k.config.Cache2kConfig
setup(Consumer<Cache2kBuilder<K, V>>) - Method in class org.cache2k.Cache2kBuilder: Call the consumer with this builder.
setup(Function<Cache2kBuilder<K, V>, CFG>, Consumer) - Method in class org.cache2k.Cache2kBuilder: Executes setup code for a feature or customization which has additional parameters and configures it via its builder.
setupWith(Function<Cache2kBuilder<K, V>, SUP>, Consumer) - Method in class org.cache2k.Cache2kBuilder: Execute setup code for a feature or customization and configure its associated configuration section via its builder.
setValue(V) - Method in interface org.cache2k.processor.MutableCacheEntry: Insert or updates the cache value assigned to this key.
setValueType(CacheType<V>) - Method in class org.cache2k.config.Cache2kConfig
setVersion(String) - Method in class org.cache2k.config.Cache2kManagerConfig: Version of the configuration.
setWeigher(CustomizationSupplier<? extends Weigher<K, V>>) - Method in class org.cache2k.config.Cache2kConfig
setWriter(CustomizationSupplier<? extends CacheWriter<K, V>>) - Method in class org.cache2k.config.Cache2kConfig
sharpExpiry(boolean) - Method in class org.cache2k.Cache2kBuilder: By default, the time of expiry is not exact, which means, a value might be visible for up to a second longer after the requested time of expiry.
SingleFeature - Interface in org.cache2k.config: Feature that distinct type is only present once.
size() - Method in class org.cache2k.config.SectionContainer
sleep(long) - Method in class org.cache2k.operation.TimeReference.Default
sleep(long) - Method in interface org.cache2k.operation.TimeReference: Wait for the specified amount of time.
STANDARD_DEFAULT_MANAGER_NAME - Static variable in class org.cache2k.CacheManager: Name of the default cache manager if not overridden, see CacheManager.setDefaultName(String).
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(CacheBuildContext<?, ?>) - Method in class org.cache2k.config.CustomizationReferenceSupplier
supply(CacheBuildContext<?, ?>) - Method in interface org.cache2k.config.CustomizationSupplier: Create or return an existing customization instance.
supply(CacheBuildContext<?, ?>) - Method in class org.cache2k.config.CustomizationSupplierByClassName
suppressExceptionUntil(K, LoadExceptionInfo<K, V>, CacheEntry<K, V>) - Method in interface org.cache2k.io.ResiliencePolicy: Called after the loader threw an exception and a previous value is available.

T

ticks() - Method in class org.cache2k.operation.TimeReference.Default
ticks() - Method in interface org.cache2k.operation.TimeReference: Returns the timer ticks since a reference point, typically milliseconds since epoch.
ticksToInstant(long) - Method in class org.cache2k.operation.TimeReference.Milliseconds
ticksToInstant(long) - Method in interface org.cache2k.operation.TimeReference: Convert a time value in ticks to an instant object.
ticksToMillisCeiling(long) - Method in class org.cache2k.operation.TimeReference.Milliseconds
ticksToMillisCeiling(long) - Method in interface org.cache2k.operation.TimeReference: Convert a duration in ticks to milliseconds, rounding up to the next full millisecond.
timeReference(TimeReference) - Method in class org.cache2k.Cache2kBuilder: Use a different time reference.
TimeReference - Interface in org.cache2k.operation: Time reference for a cache.
TimeReference.Default - Class in org.cache2k.operation
TimeReference.Milliseconds - Class in org.cache2k.operation
timerLag(long, TimeUnit) - Method in class org.cache2k.Cache2kBuilder
timerLag(Duration) - Method in class org.cache2k.Cache2kBuilder: Change the maximum lag time for timer events.
ToggleFeature - Class in org.cache2k.config: Base class for a cache feature that can be enabled or disables and appears only once in the feature set.
ToggleFeature() - Constructor for class org.cache2k.config.ToggleFeature
toSharpTime(long) - Static method in class org.cache2k.expiry.Expiry: Convert the time value to a time representing a sharp expiry.
toString() - Method in class org.cache2k.AbstractCache
toString() - Method in interface org.cache2k.Cache: Returns internal information.
toString() - Method in class org.cache2k.config.CacheTypeCapture
toString() - Method in class org.cache2k.config.SectionContainer
toString() - Method in class org.cache2k.config.ToggleFeature: Override if this takes additional parameters.
toString() - Method in class org.cache2k.ForwardingCache: Forwards to delegate but adds the simple class name to the output.
toTicks(Duration) - Method in class org.cache2k.operation.TimeReference.Milliseconds
toTicks(Duration) - Method in interface org.cache2k.operation.TimeReference: Convert a duration to ticks.

U

UNSET_INT - Static variable in class org.cache2k.config.Cache2kConfig: Constant for unset parameter value.
UNSET_LONG - Static variable in class org.cache2k.config.Cache2kConfig: Constant for unset parameter value.

V

validate() - Method in class org.cache2k.config.CustomizationSupplierByClassName
validate() - Method in interface org.cache2k.config.ValidatingConfigBean: Check whether the configuration is valid, especially whether mandatory fields are set.
ValidatingConfigBean - Interface in org.cache2k.config: Configuration bean that is able to validate itself.
valueType(Class<V2>) - Method in class org.cache2k.Cache2kBuilder: Sets the value type to use.
valueType(CacheType<V2>) - 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

weigh(K, V) - Method in interface org.cache2k.operation.Weigher: Returns a weight for the given cached value.
weigher(Weigher<K, V>) - Method in class org.cache2k.Cache2kBuilder: Set the weigher to be used to calculate the entry weight.
Weigher<K,V> - Interface in org.cache2k.operation: Allows giving cached values a weight and limit the cache capacity by total weight.
with(Class<CFG>, Consumer) - Method in class org.cache2k.Cache2kBuilder: Configure a config section.
WithSection<CFG extends ConfigSection<CFG,B>,B extends SectionBuilder<B,CFG>> - Interface in org.cache2k.config: Supplier for a customization that has its own config section.
wrap(CacheBuildContext<K, V>, Cache<K, V>) - Method in interface org.cache2k.config.CacheWrapper
write(K, V) - Method in interface org.cache2k.io.CacheWriter: Called when the value was updated or inserted into the cache.
writer(CacheWriter<K, V>) - Method in class org.cache2k.Cache2kBuilder: Enables write through operation and sets a writer customization that gets called synchronously upon cache mutations.

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