Skip navigation links
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.
addListener(CacheEntryOperationListener<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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
Key/value source with bulk get and prefetching.
asMap() - Method in interface org.cache2k.Cache
Returns a map interface for operating with this cache.
AUTO_EXPIRY - Static variable in interface org.cache2k.ValueWithExpiryTime
Deprecated.
Instance of an expiry calculator that uses the expiry value from the value object, or returns the maximum value, if the interface is not implemented by the value.
AutoEntryRefreshController<T> - Class in org.cache2k
Deprecated.
AutoEntryRefreshController() - Constructor for class org.cache2k.AutoEntryRefreshController
Deprecated.
 

B

backgroundRefresh(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
build() - Method in class org.cache2k.Cache2kBuilder
Builds a cache with the specified configuration parameters.
build() - Method in class org.cache2k.CacheBuilder
Deprecated.
 
buildConfigurationSection() - Method in interface org.cache2k.configuration.ConfigurationSectionBuilder
 
BulkCacheSource<K,V> - Interface in org.cache2k
Deprecated.

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.
CacheBuilder<K,V> - Class in org.cache2k
Deprecated.
Replaced with Cache2kBuilder
CacheBuilder(Cache2kBuilder<K, V>) - Constructor for class org.cache2k.CacheBuilder
Deprecated.
 
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
 
CacheMisconfigurationException - Exception in org.cache2k
Deprecated.
will be removed or moved to the implementation
CacheMisconfigurationException() - Constructor for exception org.cache2k.CacheMisconfigurationException
Deprecated.
 
CacheMisconfigurationException(String) - Constructor for exception org.cache2k.CacheMisconfigurationException
Deprecated.
 
CacheMisconfigurationException(String, Throwable) - Constructor for exception org.cache2k.CacheMisconfigurationException
Deprecated.
 
CacheMisconfigurationException(Throwable) - Constructor for exception org.cache2k.CacheMisconfigurationException
Deprecated.
 
CacheOperationCompletionListener - Interface in org.cache2k
A listener implemented by the applications to get notifications after a Cache.loadAll(org.cache2k.CacheOperationCompletionListener, java.lang.Iterable<? extends K>) or (@link Cache#reload} has been completed.
CacheSource<K,V> - Interface in org.cache2k
Deprecated.
Replaced by CacheLoader
CacheSourceWithMetaInfo<K,V> - Class in org.cache2k
Deprecated.
CacheSourceWithMetaInfo() - Constructor for class org.cache2k.CacheSourceWithMetaInfo
Deprecated.
 
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.EntryExpiryCalculator
Deprecated.
 
calculateExpiryTime(K, Throwable, long) - Method in interface org.cache2k.ExceptionExpiryCalculator
Deprecated.
 
calculateExpiryTime(K, V, long, CacheEntry<K, V>) - Method in interface org.cache2k.expiry.ExpiryPolicy
Returns the time of expiry in milliseconds since epoch.
calculateNextRefreshTime(T, T, long, long) - Method in class org.cache2k.AutoEntryRefreshController
Deprecated.
 
calculateNextRefreshTime(T, T, long, long) - Method in class org.cache2k.EntryRefreshController
Deprecated.
 
calculateNextRefreshTime(T, T, long, long) - Method in interface org.cache2k.RefreshController
Deprecated.
Returns the time of next refresh (expiry time) 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.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(K) - Method in interface org.cache2k.Cache
Deprecated.
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.
createConfiguration() - Method in class org.cache2k.CacheBuilder
Deprecated.
 
CustomizationCollection<T> - Interface in org.cache2k.configuration
Collection of customizations.
CustomizationException - Exception in org.cache2k
Wraps an exception that happened during processing of one entry, e.g.
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.
destroy() - Method in interface org.cache2k.Cache
Deprecated.
destroy() - Method in class org.cache2k.CacheManager
Deprecated.
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.
entryCapacity(int) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
entryExpiryCalculator(EntryExpiryCalculator<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
EntryExpiryCalculator<K,V> - Interface in org.cache2k
Deprecated.
replaced with ExpiryPolicy
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.
EntryRefreshController<T> - Class in org.cache2k
Deprecated. 
EntryRefreshController() - Constructor for class org.cache2k.EntryRefreshController
Deprecated.
 
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(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
ETERNAL - Static variable in interface org.cache2k.expiry.ExpiryTimeValues
Return value signalling to keep the value forever in the cache, switching off expiry.
evictionSegmentCount(int) - Method in class org.cache2k.Cache2kBuilder
Number of eviction segments.
exceptionExpiryCalculator(ExceptionExpiryCalculator<K>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
ExceptionExpiryCalculator<K> - Interface in org.cache2k
Deprecated.
replaced with ResiliencePolicy
exceptionExpiryDuration(long, TimeUnit) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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(ExceptionPropagator) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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 inside expire policy and friends.
Expiry() - Constructor for class org.cache2k.expiry.Expiry
 
EXPIRY_NOT_ETERNAL - Static variable in class org.cache2k.configuration.Cache2kConfiguration
 
expiryCalculator(ExpiryPolicy<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
expiryDuration(long, TimeUnit) - Method in class org.cache2k.CacheBuilder
expiryMillis(long) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
expirySecs(int) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
ExpiryTimeValues - Interface in org.cache2k.expiry
Expiry time values that have a special meaning.

F

flush() - Method in interface org.cache2k.Cache
Deprecated. 
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.
fromConfig(Cache2kConfiguration<K1, T>) - Static method in class org.cache2k.CacheBuilder
Deprecated.
 

G

get(K) - Method in interface org.cache2k.Cache
Returns a value associated by the given key, that contains a non expired value.
get(K) - Method in interface org.cache2k.CacheSource
Deprecated.
 
get(K, long, V, long) - Method in class org.cache2k.CacheSourceWithMetaInfo
Deprecated.
 
get(K) - Method in interface org.cache2k.KeyValueSource
Returns object via the 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 objects via the key.
getAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache
Retrieve values from the cache associated with the provided keys.
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.
getCacheExpiryTime() - Method in interface org.cache2k.ValueWithExpiryTime
Deprecated.
Return time of next refresh (expiry time).
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
 
getConfig() - Method in class org.cache2k.CacheBuilder
Deprecated.
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 associated by the given key, that contains a non expired value.
getEntryCapacity() - Method in class org.cache2k.configuration.Cache2kConfiguration
 
getEvictionSegmentCount() - 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
 
getExpirySeconds() - 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 either by load or put.
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
Retry after the first exceptions happened for a key.
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
 
getNextRefreshTime() - Method in interface org.cache2k.ValueWithNextRefreshTime
Deprecated.
Return time of next refresh (expiry time).
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 after the first exceptions 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.
getTotalEntryCount() - Method in interface org.cache2k.Cache
Deprecated.
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 parameterized 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.
getValues(List<CacheEntry<K, V>>, long) - Method in interface org.cache2k.BulkCacheSource
Deprecated.
Retrieve the values for the given cache entries.
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
This ia a parameterized type and the concrete types are known.
hasTypeArguments() - Method in class org.cache2k.configuration.CacheTypeCapture
 
hasTypeArguments() - Method in class org.cache2k.configuration.CacheTypeCapture.OfGeneric
 

I

implementation(Class<?>) - Method in class org.cache2k.CacheBuilder
Deprecated.
Removed without replacement.
init(ResiliencePolicy.Context) - Method in class org.cache2k.integration.ResiliencePolicy
Called before any other call.
INSTANCE - Static variable in class org.cache2k.AutoEntryRefreshController
Deprecated.
 
INSTANCE - Static variable in class org.cache2k.EntryRefreshController
Deprecated.
 
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
 
isBackgroundRefresh() - Method in class org.cache2k.configuration.Cache2kConfiguration
isClosed() - Method in interface org.cache2k.Cache
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()
isDestroyed() - Method in class org.cache2k.CacheManager
Deprecated.
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 interface org.cache2k.Cache
Deprecated.
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.
keepDataAfterExpired(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
keyType(Class<K2>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
keyType(CacheType<K2>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
loadAll(CacheOperationCompletionListener, Iterable<? extends K>) - 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(CacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder
 
loader(AdvancedCacheLoader<K, V>) - Method in class org.cache2k.Cache2kBuilder
 
loader(CacheLoader<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
loader(AdvancedCacheLoader<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
loaderThreadCount(int) - Method in class org.cache2k.CacheBuilder
Deprecated.
 

M

manager(CacheManager) - Method in class org.cache2k.Cache2kBuilder
The manager, the created cache will belong to.
manager(CacheManager) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
maxSize(int) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
maxSizeBound(int) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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 if the entry is existing in the cache.

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.
name(Class<?>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
name(Object, String) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
name(Class<?>, String) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
name(String) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
NEUTRAL - Static variable in interface org.cache2k.expiry.ExpiryTimeValues
Don't change the expiry of the entry.
newCache() - Static method in class org.cache2k.CacheBuilder
Deprecated.
 
newCache(Class<K>, Class<V>) - Static method in class org.cache2k.CacheBuilder
Deprecated.
 
newCache(Class<K>, Class<C>, Class<T>) - Static method in class org.cache2k.CacheBuilder
Deprecated.
 
NO_CACHE - Static variable in interface org.cache2k.expiry.ExpiryTimeValues
Value should not be cached.
NOW - Static variable in interface org.cache2k.expiry.ExpiryTimeValues

O

of(Class<K>, Class<T>) - Static method in class org.cache2k.Cache2kBuilder
Create a new cache builder for key and value types are 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(org.cache2k.CacheOperationCompletionListener, java.lang.Iterable<? extends K>) or (@link Cache#reload} 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 writer 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 writer 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 writer ran successfully.
onException(Throwable) - Method in interface org.cache2k.CacheOperationCompletionListener
The operation could not completed, because of an error.
org.cache2k - package org.cache2k
 
org.cache2k.configuration - package org.cache2k.configuration
 
org.cache2k.event - package org.cache2k.event
 
org.cache2k.expiry - package org.cache2k.expiry
Set of interfaces for customizing the expiry behavior.
org.cache2k.integration - package org.cache2k.integration
 
org.cache2k.processor - package org.cache2k.processor
 
org.cache2k.spi - package org.cache2k.spi
 

P

peek(K) - Method in interface org.cache2k.Cache
Returns the value if it is mapped within the cache and it is not expired, or null.
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 associated by the given key, that contains a non expired value.
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 about the intend to retrieve the value for this key in the near future.
prefetch(K) - Method in interface org.cache2k.Cache
Notifies about the intend to retrieve the value for this key in the near future.
prefetch(CacheOperationCompletionListener, K) - Method in interface org.cache2k.Cache
Notifies about the intend to retrieve the value for this key in the near future.
prefetch(Iterable<? extends K>) - Method in interface org.cache2k.Cache
prefetch(List<? extends K>, int, int) - Method in interface org.cache2k.Cache
Deprecated.
use a sublist and Cache.prefetch(Iterable)
prefetchAll(CacheOperationCompletionListener, Iterable<? extends K>) - Method in interface org.cache2k.AdvancedKeyValueSource
Notify about the intend to retrieve the value for the keys in the near future.
prefetchAll(Iterable<? extends K>) - Method in interface org.cache2k.Cache
Notifies about the intend to retrieve the value for the keys in the near future.
prefetchAll(CacheOperationCompletionListener, Iterable<? extends K>) - Method in interface org.cache2k.Cache
Notifies about the intend to retrieve the value for this key in the near future.
prefetchAll(CacheOperationCompletionListener, K...) - Method in interface org.cache2k.Cache
Notifies about the intend 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.
PropagatedCacheException - Exception in org.cache2k
Deprecated.
PropagatedCacheException(String, Throwable) - Constructor for exception org.cache2k.PropagatedCacheException
Deprecated.
 
PropagatedCacheException(Throwable) - Constructor for exception org.cache2k.PropagatedCacheException
Deprecated.
 
propagateException(K, ExceptionInformation) - Method in interface org.cache2k.integration.ExceptionPropagator
Generate runtime exception to throw.
PROVIDER - Static variable in class org.cache2k.CacheManager
 
purge() - Method in interface org.cache2k.Cache
Deprecated. 
put(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.
put(K, V) - Method in interface org.cache2k.KeyValueStore
Insert a new value and call the writer, if registered.
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 all elements of the map into the cache and call the writer, if registered.
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.
refreshAhead(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
refreshController(RefreshController) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
RefreshController<T> - Interface in org.cache2k
Deprecated.
registerCache2kExtension() - Method in interface org.cache2k.spi.Cache2kExtensionProvider
 
reloadAll(CacheOperationCompletionListener, Iterable<? extends K>) - 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 mapping from the cache and call the writer, if registered.
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 and call the writer, if registered.
removeAllAtOnce(Set<K>) - Method in interface org.cache2k.Cache
Deprecated.
no replacement planed, will be removed
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 with in the entry processor to abort the processing to let the cache do some, possibly asynchronous processing, for example the load of a value, or, the retrieval of data from secondary storage.
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
 
setBackgroundRefresh(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.
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
 
setEvictionSegmentCount(int) - 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
 
setExpirySeconds(int) - 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<CacheLoader<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.
sharpExpiry(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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
 
source(CacheSourceWithMetaInfo<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
source(CacheSource<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
source(BulkCacheSource<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
storeByReference(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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
If an exceptions gets thrown by the cache loader, suppress it if there is a previous value.
suppressExceptions(boolean) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
valueType(Class<T2>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
valueType(CacheType<T2>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
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.
ValueWithExpiryTime - Interface in org.cache2k
Deprecated.
replaced with ValueWithExpiryTime
ValueWithNextRefreshTime - Interface in org.cache2k
Deprecated.
Replaces bye ValueWithExpiryTime

W

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
 
writer(CacheWriter<K, V>) - Method in class org.cache2k.CacheBuilder
Deprecated.
 
A B C D E F G H I K L M N O P R S T V W 
Skip navigation links

cache2k API documentation. Copyright © 2000–2016 headissue GmbH, Munich.