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

A

AnyBuilder<K,T,C> - Interface in org.cache2k

B type of the root builder P parent builder

AUTO_EXPIRY - Static variable in interface org.cache2k.ValueWithExpiryTime

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.

Use ValueWithExpiryTime.AUTO_EXPIRY

AutoEntryRefreshController() - Constructor for class org.cache2k.AutoEntryRefreshController

Deprecated.

B

backgroundRefresh(boolean) - Method in class org.cache2k.RootAnyBuilder

BaseAnyBuilder<K,T,C> - Class in org.cache2k

Base builder which defines top level methods delegating to the root configuration builder.

build() - Method in interface org.cache2k.AnyBuilder

Builds the instance which is the target of nested builders.

build() - Method in class org.cache2k.BaseAnyBuilder

build() - Method in class org.cache2k.CacheBuilder

Builds a cache with the specified configuration parameters.

build() - Method in class org.cache2k.spi.VoidConfigBuilder

BulkCacheSource<K,T> - Interface in org.cache2k

bulkCacheSource - Variable in class org.cache2k.CacheBuilder

ByReferenceHeapStorage - Interface in org.cache2k.storage

Storage which keeps the data in a simple hash map in the heap.

bytesCapacity(int) - Method in class org.cache2k.StorageConfiguration.Builder

C

Cache<K,T> - Interface in org.cache2k

Interface to the cache2k cache implementation.

Cache2kCoreProvider - Class in org.cache2k.spi

For API internal use only.

Cache2kCoreProvider() - Constructor for class org.cache2k.spi.Cache2kCoreProvider

Cache2kExtensionProvider - Interface in org.cache2k.spi

Interface for a generic cache2k extension.

CacheBuilder<K,T> - Class in org.cache2k

CacheBuilder() - Constructor for class org.cache2k.CacheBuilder

CacheConfig - Class in org.cache2k

Cache configuration.

CacheConfig() - Constructor for class org.cache2k.CacheConfig

CacheEntry<K,T> - Interface in org.cache2k

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

CacheException(String, Throwable, boolean, boolean) - Constructor for exception org.cache2k.CacheException

CacheManager - Class in org.cache2k

CacheManager() - Constructor for class org.cache2k.CacheManager

CacheMisconfigurationException - Exception in org.cache2k

A misconfiguration upon cache initialization is detected.

CacheMisconfigurationException() - Constructor for exception org.cache2k.CacheMisconfigurationException

CacheMisconfigurationException(String) - Constructor for exception org.cache2k.CacheMisconfigurationException

CacheMisconfigurationException(String, Throwable) - Constructor for exception org.cache2k.CacheMisconfigurationException

CacheMisconfigurationException(Throwable) - Constructor for exception org.cache2k.CacheMisconfigurationException

CacheMisconfigurationException(String, Throwable, boolean, boolean) - Constructor for exception org.cache2k.CacheMisconfigurationException

cacheSource - Variable in class org.cache2k.CacheBuilder

CacheSource<K,T> - Interface in org.cache2k

An interface to get a value by a key.

cacheSourceWithMetaInfo - Variable in class org.cache2k.CacheBuilder

CacheSourceWithMetaInfo<K,T> - Class in org.cache2k

CacheSourceWithMetaInfo() - Constructor for class org.cache2k.CacheSourceWithMetaInfo

calculateExpiryTime(K, T, long, CacheEntry<K, T>) - Method in interface org.cache2k.EntryExpiryCalculator

Returns the time of expiry in milliseconds since epoch.

calculateExpiryTime(K, Throwable, long) - Method in interface org.cache2k.ExceptionExpiryCalculator

Parameter semantics identical to EntryExpiryCalculator.calculateExpiryTime(K, T, long, org.cache2k.CacheEntry<K, T>)

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

Returns the time of next refresh (expiry time) in milliseconds since epoch.

clear() - Method in interface org.cache2k.Cache

Clear the cache contents

clear() - Method in class org.cache2k.CacheManager

Clear all caches associated to this cache manager

ClosableIterator<E> - Interface in org.cache2k

After the usage of the iterator close should be called to free resources.

close() - Method in interface org.cache2k.ClosableIterator

Immediately free resources held by the iterator.

config - Variable in class org.cache2k.RootAnyBuilder

createConfiguration() - Method in interface org.cache2k.AnyBuilder

Create the configuration of this submodule (not the complete configuration).

createConfiguration() - Method in class org.cache2k.RootAnyBuilder

createConfiguration() - Method in class org.cache2k.spi.VoidConfigBuilder

createConfiguration() - Method in class org.cache2k.StorageConfiguration.Builder

createConfigurationBuilder(CacheBuilder<K, T>) - Method in interface org.cache2k.spi.StorageImplementation

ctor(Class<K>, Class<T>, Class<?>) - Method in class org.cache2k.CacheBuilder

Builder is constructed from prototype

D

DEFAULT_MANAGER_NAME - Static variable in class org.cache2k.CacheManager

destroy() - Method in interface org.cache2k.Cache

Free all resources and remove the cache from the CacheManager.

destroy() - Method in class org.cache2k.CacheManager

Destroy all caches associated to this cache manager.

E

entryCapacity(int) - Method in class org.cache2k.StorageConfiguration.Builder

entryExpiryCalculator - Variable in class org.cache2k.CacheBuilder

entryExpiryCalculator(EntryExpiryCalculator) - Method in class org.cache2k.CacheBuilder

Set expiry calculator to use.

EntryExpiryCalculator<K,T> - Interface in org.cache2k

A custom policy which allows to calculate a specific expiry time per entry.

EntryRefreshController<T> - Class in org.cache2k

Deprecated.

EntryRefreshController() - Constructor for class org.cache2k.EntryRefreshController

Deprecated.

eternal(boolean) - Method in class org.cache2k.CacheBuilder

Keep entries forever.

exceptionExpiryCalculator - Variable in class org.cache2k.CacheBuilder

exceptionExpiryCalculator(ExceptionExpiryCalculator) - Method in class org.cache2k.CacheBuilder

ExceptionExpiryCalculator<K> - Interface in org.cache2k

Special expiry calculator to calculate a separate expiry time if an exceptions was thrown in the cache source.

exceptionExpiryDuration(long, TimeUnit) - Method in class org.cache2k.CacheBuilder

Separate timeout in the case an exception was thrown in the cache source.

experimentalBulkCacheSource - Variable in class org.cache2k.CacheBuilder

ExperimentalBulkCacheSource<K,T> - Interface in org.cache2k

Deprecated.

expiryDuration(long, TimeUnit) - Method in class org.cache2k.CacheBuilder

Set the time duration after an entry expires.

expiryMillis(long) - Method in class org.cache2k.CacheBuilder

Deprecated.

since 0.20, please use CacheBuilder.expiryDuration(long, java.util.concurrent.TimeUnit)

expirySecs(int) - Method in class org.cache2k.CacheBuilder

Deprecated.

since 0.20, please use CacheBuilder.expiryDuration(long, java.util.concurrent.TimeUnit)

extra(Class<? extends StorageImplementation<EXTRA_CONFIG_BUILDER>>) - Method in class org.cache2k.StorageConfiguration.Builder

extra() - Method in class org.cache2k.StorageConfiguration.Builder

F

flush() - Method in interface org.cache2k.Cache

Ensure that any transient data is stored in the persistence storage.

flushOnClose(boolean) - Method in class org.cache2k.StorageConfiguration.Builder

Flush contents on close.

G

get(K) - Method in interface org.cache2k.Cache

Returns object in the cache that is mapped to the key.

get(K) - Method in interface org.cache2k.CacheSource

get(K, long, T, long) - Method in class org.cache2k.CacheSourceWithMetaInfo

get(K) - Method in interface org.cache2k.KeyValueSource

Returns object mapped to key

getAll(Set<? extends K>) - Method in interface org.cache2k.Cache

Disclaimer: This method is here to be able to support known coding similar to JSR107.

getBuilderImplementation() - Method in class org.cache2k.spi.Cache2kCoreProvider

getBulk(K[], T[], BitSet, int, int) - Method in interface org.cache2k.ExperimentalBulkCacheSource

Deprecated.

Retrieves the objects associated with the given keys in the result array.

getBytesCapacity() - Method in class org.cache2k.StorageConfiguration

getCache(String) - Method in class org.cache2k.CacheManager

getCacheExpiryTime() - Method in interface org.cache2k.ValueWithExpiryTime

Return time of next refresh (expiry time).

getConfig() - Method in class org.cache2k.CacheBuilder

Deprecated.

getDefaultName() - Static method in class org.cache2k.CacheManager

Name of the default cache manager, which is "default" by default.

getDefaultPersistenceStoreImplementation() - Method in class org.cache2k.spi.Cache2kCoreProvider

getEntryCapacity() - Method in class org.cache2k.StorageConfiguration

getEntryType() - Method in class org.cache2k.CacheConfig

getException() - Method in interface org.cache2k.CacheEntry

getExceptionExpiryMillis() - Method in class org.cache2k.CacheConfig

getExpiryMillis() - Method in class org.cache2k.CacheConfig

getExpirySeconds() - Method in class org.cache2k.CacheConfig

getExtraConfiguration() - Method in class org.cache2k.StorageConfiguration

getFlushIntervalMillis() - Method in class org.cache2k.StorageConfiguration

Sync interval in milliseconds.

getHeapEntryCapacity() - Method in class org.cache2k.CacheConfig

getImplementation() - Method in class org.cache2k.CacheConfig

getImplementation() - Method in class org.cache2k.StorageConfiguration

getInstance() - Static method in class org.cache2k.CacheManager

Get the default cache manager for the current class loader

getInstance(String) - Static method in class org.cache2k.CacheManager

getInstance() - Static method in class org.cache2k.spi.SingleProviderResolver

getInstance(ClassLoader) - Static method in class org.cache2k.spi.SingleProviderResolver

getKey() - Method in interface org.cache2k.CacheEntry

getKeyType() - Method in class org.cache2k.CacheConfig

getLastModification() - Method in interface org.cache2k.CacheEntry

Time the entry was last updated either by a fetch via the CacheSource or by a put.

getLocation() - Method in class org.cache2k.StorageConfiguration

getMaxSize() - Method in class org.cache2k.CacheConfig

getMaxSizeHighBound() - Method in class org.cache2k.CacheConfig

getMaxSizeLowBound() - Method in class org.cache2k.CacheConfig

getModuleConfiguration() - Method in class org.cache2k.CacheConfig

getName() - Method in interface org.cache2k.Cache

getName() - Method in class org.cache2k.CacheConfig

getName() - Method in class org.cache2k.CacheManager

getNextRefreshTime() - Method in interface org.cache2k.ValueWithNextRefreshTime

Deprecated.

Return time of next refresh (expiry time).

getStorageModules() - Method in class org.cache2k.CacheConfig

getStorageName() - Method in class org.cache2k.StorageConfiguration

getTotalEntryCount() - Method in interface org.cache2k.Cache

Number of entries the cache holds in total.

getValue() - Method in interface org.cache2k.CacheEntry

getValues(List<CacheEntry<K, T>>, long) - Method in interface org.cache2k.BulkCacheSource

Retrieve the values for the given cache entries.

getValueType() - Method in class org.cache2k.CacheConfig

H

heapEntryCapacity(int) - Method in class org.cache2k.CacheBuilder

I

implementation(Class<?>) - Method in class org.cache2k.CacheBuilder

implementation(Class<? extends StorageImplementation<EXTRA_CONFIG_BUILDER>>) - Method in class org.cache2k.StorageConfiguration.Builder

INSTANCE - Static variable in class org.cache2k.AutoEntryRefreshController

Deprecated.

INSTANCE - Static variable in class org.cache2k.EntryRefreshController

Deprecated.

isBackgroundRefresh() - Method in class org.cache2k.CacheConfig

isDestroyed() - Method in class org.cache2k.CacheManager

isEternal() - Method in class org.cache2k.CacheConfig

isFlushOnClose() - Method in class org.cache2k.StorageConfiguration

isIgnoreModifications() - Method in class org.cache2k.StorageConfiguration

isKeepDataAfterExpired() - Method in class org.cache2k.CacheConfig

isPassivation() - Method in class org.cache2k.StorageConfiguration

isPurgeOnStartup() - Method in class org.cache2k.StorageConfiguration

isReadOnly() - Method in class org.cache2k.StorageConfiguration

isReliable() - Method in class org.cache2k.StorageConfiguration

isSharpExpiry() - Method in class org.cache2k.CacheConfig

isSuppressExceptions() - Method in class org.cache2k.CacheConfig

iterator() - Method in interface org.cache2k.Cache

Iterate all entries in the cache.

iterator() - Method in class org.cache2k.CacheManager

K

keepDataAfterExpired(boolean) - Method in class org.cache2k.CacheBuilder

KeyValueSource<K,T> - Interface in org.cache2k

Simple interface to return a value selected by a key object.

L

location(String) - Method in class org.cache2k.StorageConfiguration.Builder

M

maxSize(int) - Method in class org.cache2k.CacheBuilder

maxSizeBound(int) - Method in class org.cache2k.CacheBuilder

MutableCacheEntry<K,T> - Interface in org.cache2k

N

name(Class<?>, String) - Method in class org.cache2k.CacheBuilder

Constructs a cache name out of the simple class name and fieldname.

name(Class<?>) - Method in class org.cache2k.CacheBuilder

name(Object, String) - Method in class org.cache2k.CacheBuilder

Constructs a cache name out of the simple class name and fieldname.

name(String) - Method in class org.cache2k.CacheBuilder

newCache(Class<K>, Class<T>) - Static method in class org.cache2k.CacheBuilder

newCache(Class<K>, Class<C>, Class<T>) - Static method in class org.cache2k.CacheBuilder

O

org.cache2k - package org.cache2k

org.cache2k.spi - package org.cache2k.spi

org.cache2k.storage - package org.cache2k.storage

P

passivation(boolean) - Method in class org.cache2k.StorageConfiguration.Builder

Only store entries in the storage that don't live in the memory any more.

peek(K) - Method in interface org.cache2k.Cache

Returns the value if it is mapped within the cache and not expired, or null.

peekEntry(K) - Method in interface org.cache2k.Cache

Returns a mapped entry from the cache or null.

persistence() - Method in class org.cache2k.BaseAnyBuilder

Adds persistence to the cache or returns a previous added persistence storage configuration node.

persistence() - Method in class org.cache2k.RootAnyBuilder

prefetch(K) - Method in interface org.cache2k.Cache

Signals the intent to call a get on the same key in the near future.

prefetch(Set<K>) - Method in interface org.cache2k.Cache

Signals the intend to call get on the set of keys in the near future.

prefetch(List<K>, int, int) - Method in interface org.cache2k.Cache

PropagatedCacheException - Exception in org.cache2k

Wraps an application exception.

PropagatedCacheException(Throwable) - Constructor for exception org.cache2k.PropagatedCacheException

purge() - Method in interface org.cache2k.Cache

Remove persistent entries, that are not longer needed.

purgeOnStartup(boolean) - Method in class org.cache2k.StorageConfiguration.Builder

put(K, T) - Method in interface org.cache2k.Cache

Set object value for the key

putIfAbsent(K, T) - Method in interface org.cache2k.Cache

R

readOnly(boolean) - Method in class org.cache2k.StorageConfiguration.Builder

Switch storage to read only mode, e.g.

refreshController - Variable in class org.cache2k.CacheBuilder

refreshController(RefreshController) - Method in class org.cache2k.CacheBuilder

Deprecated.

since 0.20, please use CacheBuilder.entryExpiryCalculator

RefreshController<T> - Interface in org.cache2k

Calculates the time when the object needs to be updated next.

register() - Method in interface org.cache2k.spi.Cache2kExtensionProvider

reliable(boolean) - Method in class org.cache2k.StorageConfiguration.Builder

False means single storage errors may be ignored.

remove(K) - Method in interface org.cache2k.Cache

Remove the object mapped to key from the cache.

removeAllAtOnce(Set<K>) - Method in interface org.cache2k.Cache

Remove the mappings for the keys atomically.

resolve(Class<T>) - Method in class org.cache2k.spi.SingleProviderResolver

Return a provider for this interface.

root() - Method in interface org.cache2k.AnyBuilder

Goes back to the root builder, to add more configuration nodes.

root - Variable in class org.cache2k.BaseAnyBuilder

root() - Method in class org.cache2k.BaseAnyBuilder

root() - Method in class org.cache2k.spi.VoidConfigBuilder

RootAnyBuilder<K,T> - Class in org.cache2k

RootModuleBuilderExtension - Class in org.cache2k

RootModuleBuilderExtension() - Constructor for class org.cache2k.RootModuleBuilderExtension

S

setBackgroundRefresh(boolean) - Method in class org.cache2k.CacheConfig

setBytesCapacity(int) - Method in class org.cache2k.StorageConfiguration

setDefaultName(String) - Static method in class org.cache2k.CacheManager

Reset the manager name once on application startup.

setEntryCapacity(int) - Method in class org.cache2k.StorageConfiguration

Capacity limit for the number of entries.

setEntryType(Class<?>) - Method in class org.cache2k.CacheConfig

setEternal(boolean) - Method in class org.cache2k.CacheConfig

Set cache entry don't expiry by time.

setException(Throwable) - Method in interface org.cache2k.MutableCacheEntry

setExceptionExpiryMillis(long) - Method in class org.cache2k.CacheConfig

setExpiryMillis(long) - Method in class org.cache2k.CacheConfig

The expiry value of all entries.

setExpirySeconds(int) - Method in class org.cache2k.CacheConfig

setExtraConfiguration(EX) - Method in class org.cache2k.StorageConfiguration

setFlushOnClose(boolean) - Method in class org.cache2k.StorageConfiguration

When closing flush data, if the storage does need this.

setHeapEntryCapacity(int) - Method in class org.cache2k.CacheConfig

Maximum number of entries that the cache keeps in the heap.

setIgnoreModifications(boolean) - Method in class org.cache2k.StorageConfiguration

setImplementation(Class<?>) - Method in class org.cache2k.CacheConfig

setImplementation(Class<? extends StorageImplementation>) - Method in class org.cache2k.StorageConfiguration

setKeepDataAfterExpired(boolean) - Method in class org.cache2k.CacheConfig

Expired data is kept in the cache until the entry is evicted by the replacement algorithm.

setKeyType(Class<?>) - Method in class org.cache2k.CacheConfig

setLocation(String) - Method in class org.cache2k.StorageConfiguration

setMaxSize(int) - Method in class org.cache2k.CacheConfig

setMaxSizeHighBound(int) - Method in class org.cache2k.CacheConfig

setMaxSizeLowBound(int) - Method in class org.cache2k.CacheConfig

setModuleConfiguration(List<Object>) - Method in class org.cache2k.CacheConfig

setName(String) - Method in class org.cache2k.CacheConfig

Sets the name of a cache.

setPassivation(boolean) - Method in class org.cache2k.StorageConfiguration

setPurgeOnStartup(boolean) - Method in class org.cache2k.StorageConfiguration

setReadOnly(boolean) - Method in class org.cache2k.StorageConfiguration

setReliable(boolean) - Method in class org.cache2k.StorageConfiguration

setSharpExpiry(boolean) - Method in class org.cache2k.CacheConfig

setStorageName(String) - Method in class org.cache2k.StorageConfiguration

setSuppressExceptions(boolean) - Method in class org.cache2k.CacheConfig

setSyncInterval(long, TimeUnit) - Method in class org.cache2k.StorageConfiguration

setValue(T) - Method in interface org.cache2k.MutableCacheEntry

setValueType(Class<?>) - Method in class org.cache2k.CacheConfig

sharpExpiry(boolean) - Method in class org.cache2k.RootAnyBuilder

SimpleSingleFileStorage - Interface in org.cache2k.storage

SingleProviderResolver - Class in org.cache2k.spi

Resolves a service provider by its interface.

source(CacheSource<K, T>) - Method in class org.cache2k.CacheBuilder

source(CacheSourceWithMetaInfo<K, T>) - Method in class org.cache2k.CacheBuilder

source(ExperimentalBulkCacheSource<K, T>) - Method in class org.cache2k.CacheBuilder

source(BulkCacheSource<K, T>) - Method in class org.cache2k.CacheBuilder

StorageConfiguration<EX> - Class in org.cache2k

StorageConfiguration() - Constructor for class org.cache2k.StorageConfiguration

StorageConfiguration.Builder<K,T,OPT_EXTRA_CONFIG> - Class in org.cache2k

StorageConfiguration.Builder() - Constructor for class org.cache2k.StorageConfiguration.Builder

StorageImplementation<B extends AnyBuilder> - Interface in org.cache2k.spi

storageName(String) - Method in class org.cache2k.StorageConfiguration.Builder

suppressExceptions(boolean) - Method in class org.cache2k.CacheBuilder

If an exceptions gets thrown by the cache source, suppress it if there is a previous value.

syncInterval(int, TimeUnit) - Method in class org.cache2k.StorageConfiguration.Builder

T

toString() - Method in interface org.cache2k.Cache

Returns information about the caches internal information.

toString() - Method in interface org.cache2k.CacheEntry

V

ValueWithExpiryTime - Interface in org.cache2k

Interface to add to a value object if it is possible to derive the expiry time from the value.

ValueWithNextRefreshTime - Interface in org.cache2k

Deprecated.

Replaces bye ValueWithExpiryTime

VoidConfigBuilder<K,T> - Class in org.cache2k.spi

A builder that actually does build nothing.

VoidConfigBuilder(CacheBuilder<K, T>) - Constructor for class org.cache2k.spi.VoidConfigBuilder

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