Cache2kConfiguration (cache2k API 1.0.0.CR1 API)

java.lang.Object
- org.cache2k.configuration.Cache2kConfiguration<K,V>

All Implemented Interfaces:

Serializable, ConfigurationBean, ConfigurationWithSections
```
public class Cache2kConfiguration<K,V>
extends Object
implements ConfigurationBean, ConfigurationWithSections
```
Configuration for a cache2k cache.
To create a cache, the Cache2kBuilder is used. All configuration properties are present on the builder and are documented in this place. Consequently all properties refer to the corresponding builder method.
The configuration bean is designed to be serializable. This is used for example to copy default configurations. The builder allows object references to customizations to be set. If this happens the configuration is not serializable. Such configuration is only used for immediate creation of one cache via the builder.
The configuration may contain additional beans, called configuration sections, that are used to configure extensions or sub modules.

Author:

Jens Wilke

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long EXPIRY_NOT_ETERNAL

Fields
Modifier and Type	Field and Description
`static long`	`EXPIRY_NOT_ETERNAL`

Constructor Summary

Constructors
Constructor and Description

Cache2kConfiguration()

Constructors
Constructor and Description
`Cache2kConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CustomizationSupplier<AdvancedCacheLoader<K,V>>`	`getAdvancedLoader()`
`CustomizationCollection<CacheEntryOperationListener<K,V>>`	`getAsyncListeners()` A set of listeners.
`long`	`getEntryCapacity()`
`int`	`getEvictionSegmentCount()`
`CustomizationSupplier<ExceptionPropagator<K>>`	`getExceptionPropagator()`
`long`	`getExpireAfterWrite()`
`CustomizationSupplier<ExpiryPolicy<K,V>>`	`getExpiryPolicy()`
`int`	`getExpirySeconds()` Deprecated. use `getExpireAfterWrite()`
`CacheType<K>`	`getKeyType()`
`CustomizationCollection<CacheEntryOperationListener<K,V>>`	`getListeners()` A set of listeners.
`CustomizationSupplier<CacheLoader<K,V>>`	`getLoader()`
`CustomizationSupplier<Executor>`	`getLoaderExecutor()`
`int`	`getLoaderThreadCount()`
`long`	`getMaxRetryInterval()`
`String`	`getName()`
`CustomizationSupplier<Executor>`	`getPrefetchExecutor()`
`long`	`getResilienceDuration()`
`CustomizationSupplier<ResiliencePolicy<K,V>>`	`getResiliencePolicy()`
`long`	`getRetryInterval()`
`ConfigurationSectionContainer`	`getSections()` Mutable collection of additional configuration sections
`CacheType<V>`	`getValueType()`
`CustomizationSupplier<CacheWriter<K,V>>`	`getWriter()`
`boolean`	`hasAsyncListeners()`
`boolean`	`hasListeners()`
`boolean`	`isBackgroundRefresh()` Deprecated. use `isRefreshAhead()`
`boolean`	`isDisableStatistics()`
`boolean`	`isEternal()`
`boolean`	`isExternalConfigurationPresent()`
`boolean`	`isKeepDataAfterExpired()`
`boolean`	`isPermitNullValues()`
`boolean`	`isRefreshAhead()`
`boolean`	`isSharpExpiry()`
`boolean`	`isStoreByReference()`
`boolean`	`isStrictEviction()`
`boolean`	`isSuppressExceptions()`
`static <K,V> Cache2kConfiguration<K,V>`	`of(CacheType<K> keyType, CacheType<V> valueType)` Construct a config instance setting the type parameters and returning a proper generic type.
`static <K,V> Cache2kConfiguration<K,V>`	`of(CacheType<K> keyType, Class<V> valueType)` Construct a config instance setting the type parameters and returning a proper generic type.
`static <K,V> Cache2kConfiguration<K,V>`	`of(Class<K> keyType, CacheType<V> valueType)` Construct a config instance setting the type parameters and returning a proper generic type.
`static <K,V> Cache2kConfiguration<K,V>`	`of(Class<K> keyType, Class<V> valueType)` Construct a config instance setting the type parameters and returning a proper generic type.
`void`	`setAdvancedLoader(CustomizationSupplier<AdvancedCacheLoader<K,V>> v)`
`void`	`setBackgroundRefresh(boolean v)` Deprecated. use `setRefreshAhead(boolean)`
`void`	`setDisableStatistics(boolean v)`
`void`	`setEntryCapacity(long v)`
`void`	`setEternal(boolean v)`
`void`	`setEvictionSegmentCount(int v)`
`void`	`setExceptionPropagator(CustomizationSupplier<ExceptionPropagator<K>> v)`
`void`	`setExpireAfterWrite(long millis)`
`void`	`setExpiryPolicy(CustomizationSupplier<ExpiryPolicy<K,V>> _expiryPolicy)`
`void`	`setExpirySeconds(int v)` Deprecated. use `setExpireAfterWrite(long)`
`void`	`setExternalConfigurationPresent(boolean v)` True, if an external configuration for the cache was found and is applied.
`void`	`setKeepDataAfterExpired(boolean v)`
`void`	`setKeyType(CacheType v)`
`void`	`setKeyType(Class<?> v)`
`void`	`setLoader(CustomizationSupplier<CacheLoader<K,V>> v)`
`void`	`setLoaderExecutor(CustomizationSupplier<Executor> v)`
`void`	`setLoaderThreadCount(int v)`
`void`	`setMaxRetryInterval(long millis)`
`void`	`setName(String name)`
`void`	`setPermitNullValues(boolean v)`
`void`	`setPrefetchExecutor(CustomizationSupplier<Executor> v)`
`void`	`setRefreshAhead(boolean v)`
`void`	`setResilienceDuration(long millis)`
`void`	`setResiliencePolicy(CustomizationSupplier<ResiliencePolicy<K,V>> _resiliencePolicy)`
`void`	`setRetryInterval(long millis)`
`void`	`setSharpExpiry(boolean v)`
`void`	`setStoreByReference(boolean v)`
`void`	`setStrictEviction(boolean v)`
`void`	`setSuppressExceptions(boolean v)`
`void`	`setValueType(CacheType v)`
`void`	`setValueType(Class<?> v)`
`void`	`setWriter(CustomizationSupplier<CacheWriter<K,V>> v)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXPIRY_NOT_ETERNAL
```
public static final long EXPIRY_NOT_ETERNAL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cache2kConfiguration
```
public Cache2kConfiguration()
```
- Method Detail
  - of
```
public static <K,V> Cache2kConfiguration<K,V> of(Class<K> keyType,
                                                 Class<V> valueType)
```
    Construct a config instance setting the type parameters and returning a proper generic type.
    
    See Also:
    
    Cache2kBuilder.keyType(Class), Cache2kBuilder.valueType(Class)
  - of
```
public static <K,V> Cache2kConfiguration<K,V> of(Class<K> keyType,
                                                 CacheType<V> valueType)
```
    Construct a config instance setting the type parameters and returning a proper generic type.
    
    See Also:
    
    Cache2kBuilder.keyType(CacheType), Cache2kBuilder.valueType(CacheType)
  - of
```
public static <K,V> Cache2kConfiguration<K,V> of(CacheType<K> keyType,
                                                 Class<V> valueType)
```
    Construct a config instance setting the type parameters and returning a proper generic type.
    
    See Also:
    
    Cache2kBuilder.keyType(Class), Cache2kBuilder.valueType(Class)
  - of
```
public static <K,V> Cache2kConfiguration<K,V> of(CacheType<K> keyType,
                                                 CacheType<V> valueType)
```
    Construct a config instance setting the type parameters and returning a proper generic type.
    
    See Also:
    
    Cache2kBuilder.keyType(CacheType), Cache2kBuilder.valueType(CacheType)
  - getName
```
public String getName()
```
    See Also:
    
    Cache2kBuilder.name(String)
  - setName
```
public void setName(String name)
```
    See Also:
    
    Cache2kBuilder.name(String)
  - getEntryCapacity
```
public long getEntryCapacity()
```
    See Also:
    
    Cache2kBuilder.entryCapacity(long)
  - setEntryCapacity
```
public void setEntryCapacity(long v)
```
  - isRefreshAhead
```
public boolean isRefreshAhead()
```
    See Also:
    
    Cache2kBuilder.refreshAhead(boolean)
  - setRefreshAhead
```
public void setRefreshAhead(boolean v)
```
    See Also:
    
    Cache2kBuilder.refreshAhead(boolean)
  - isBackgroundRefresh
```
public boolean isBackgroundRefresh()
```
    Deprecated. use isRefreshAhead()
    
    See Also:
    
    Cache2kBuilder.refreshAhead(boolean)
  - setBackgroundRefresh
```
public void setBackgroundRefresh(boolean v)
```
    Deprecated. use setRefreshAhead(boolean)
    
    See Also:
    
    Cache2kBuilder.refreshAhead(boolean)
  - getKeyType
```
public CacheType<K> getKeyType()
```
  - setKeyType
```
public void setKeyType(Class<?> v)
```
    See Also:
    
    Cache2kBuilder.keyType(Class), for a general discussion on types
  - setKeyType
```
public void setKeyType(CacheType v)
```
    See Also:
    
    Cache2kBuilder.keyType(CacheType), for a general discussion on types
  - getValueType
```
public CacheType<V> getValueType()
```
  - setValueType
```
public void setValueType(Class<?> v)
```
    See Also:
    
    Cache2kBuilder.valueType(Class), for a general discussion on types
  - setValueType
```
public void setValueType(CacheType v)
```
    See Also:
    
    Cache2kBuilder.valueType(CacheType), for a general discussion on types
  - isEternal
```
public boolean isEternal()
```
  - setEternal
```
public void setEternal(boolean v)
```
    See Also:
    
    Cache2kBuilder.eternal(boolean)
  - setExpirySeconds
```
public void setExpirySeconds(int v)
```
    Deprecated. use setExpireAfterWrite(long)
  - getExpirySeconds
```
public int getExpirySeconds()
```
    Deprecated. use getExpireAfterWrite()
  - getExpireAfterWrite
```
public long getExpireAfterWrite()
```
  - setExpireAfterWrite
```
public void setExpireAfterWrite(long millis)
```
    See Also:
    
    Cache2kBuilder.expireAfterWrite(long, java.util.concurrent.TimeUnit)
  - getRetryInterval
```
public long getRetryInterval()
```
    See Also:
    
    Cache2kBuilder.retryInterval(long, java.util.concurrent.TimeUnit)
  - setRetryInterval
```
public void setRetryInterval(long millis)
```
    See Also:
    
    Cache2kBuilder.retryInterval(long, java.util.concurrent.TimeUnit)
  - getMaxRetryInterval
```
public long getMaxRetryInterval()
```
    See Also:
    
    Cache2kBuilder.maxRetryInterval(long, java.util.concurrent.TimeUnit)
  - setMaxRetryInterval
```
public void setMaxRetryInterval(long millis)
```
    See Also:
    
    Cache2kBuilder.maxRetryInterval(long, java.util.concurrent.TimeUnit)
  - getResilienceDuration
```
public long getResilienceDuration()
```
    See Also:
    
    Cache2kBuilder.resilienceDuration(long, java.util.concurrent.TimeUnit)
  - setResilienceDuration
```
public void setResilienceDuration(long millis)
```
    See Also:
    
    Cache2kBuilder.resilienceDuration(long, java.util.concurrent.TimeUnit)
  - isKeepDataAfterExpired
```
public boolean isKeepDataAfterExpired()
```
  - setKeepDataAfterExpired
```
public void setKeepDataAfterExpired(boolean v)
```
    See Also:
    
    Cache2kBuilder.keepDataAfterExpired(boolean)
  - isSharpExpiry
```
public boolean isSharpExpiry()
```
  - setSharpExpiry
```
public void setSharpExpiry(boolean v)
```
    See Also:
    
    Cache2kBuilder.sharpExpiry(boolean)
  - isSuppressExceptions
```
public boolean isSuppressExceptions()
```
  - setSuppressExceptions
```
public void setSuppressExceptions(boolean v)
```
    See Also:
    
    Cache2kBuilder.suppressExceptions(boolean)
  - isExternalConfigurationPresent
```
public boolean isExternalConfigurationPresent()
```
  - setExternalConfigurationPresent
```
public void setExternalConfigurationPresent(boolean v)
```
    True, if an external configuration for the cache was found and is applied.
  - getSections
```
public ConfigurationSectionContainer getSections()
```
    Mutable collection of additional configuration sections
    
    Specified by:
    
    getSections in interface ConfigurationWithSections
  - getLoader
```
public CustomizationSupplier<CacheLoader<K,V>> getLoader()
```
  - setLoader
```
public void setLoader(CustomizationSupplier<CacheLoader<K,V>> v)
```
  - getAdvancedLoader
```
public CustomizationSupplier<AdvancedCacheLoader<K,V>> getAdvancedLoader()
```
  - setAdvancedLoader
```
public void setAdvancedLoader(CustomizationSupplier<AdvancedCacheLoader<K,V>> v)
```
  - getLoaderThreadCount
```
public int getLoaderThreadCount()
```
  - setLoaderThreadCount
```
public void setLoaderThreadCount(int v)
```
    See Also:
    
    Cache2kBuilder.loaderThreadCount(int)
  - getExpiryPolicy
```
public CustomizationSupplier<ExpiryPolicy<K,V>> getExpiryPolicy()
```
  - setExpiryPolicy
```
public void setExpiryPolicy(CustomizationSupplier<ExpiryPolicy<K,V>> _expiryPolicy)
```
  - getWriter
```
public CustomizationSupplier<CacheWriter<K,V>> getWriter()
```
  - setWriter
```
public void setWriter(CustomizationSupplier<CacheWriter<K,V>> v)
```
    See Also:
    
    Cache2kBuilder.writer(CacheWriter)
  - isStoreByReference
```
public boolean isStoreByReference()
```
  - setStoreByReference
```
public void setStoreByReference(boolean v)
```
    See Also:
    
    Cache2kBuilder.storeByReference(boolean)
  - getExceptionPropagator
```
public CustomizationSupplier<ExceptionPropagator<K>> getExceptionPropagator()
```
  - setExceptionPropagator
```
public void setExceptionPropagator(CustomizationSupplier<ExceptionPropagator<K>> v)
```
    See Also:
    
    Cache2kBuilder.exceptionPropagator(ExceptionPropagator)
  - getListeners
```
public CustomizationCollection<CacheEntryOperationListener<K,V>> getListeners()
```
    A set of listeners. Listeners added in this collection will be executed in a synchronous mode, meaning, further processing for an entry will stall until a registered listener is executed. The expiry will be always executed asynchronously.
    A listener can be added by adding it to the collection. Duplicate (in terms of equal objects) listeners will be ignored.
    
    Returns:
    
    Mutable collection of listeners
  - hasListeners
```
public boolean hasListeners()
```
    Returns:
    
    True if listeners are added to this configuration.
  - getAsyncListeners
```
public CustomizationCollection<CacheEntryOperationListener<K,V>> getAsyncListeners()
```
    A set of listeners. A listener can be added by adding it to the collection. Duplicate (in terms of equal objects) listeners will be ignored.
    
    Returns:
    
    Mutable collection of listeners
  - hasAsyncListeners
```
public boolean hasAsyncListeners()
```
    Returns:
    
    True if listeners are added to this configuration.
  - getResiliencePolicy
```
public CustomizationSupplier<ResiliencePolicy<K,V>> getResiliencePolicy()
```
  - setResiliencePolicy
```
public void setResiliencePolicy(CustomizationSupplier<ResiliencePolicy<K,V>> _resiliencePolicy)
```
    See Also:
    
    Cache2kBuilder.resiliencePolicy(org.cache2k.integration.ResiliencePolicy<K, V>)
  - isStrictEviction
```
public boolean isStrictEviction()
```
  - setStrictEviction
```
public void setStrictEviction(boolean v)
```
    See Also:
    
    Cache2kBuilder.strictEviction(boolean)
  - isPermitNullValues
```
public boolean isPermitNullValues()
```
  - setPermitNullValues
```
public void setPermitNullValues(boolean v)
```
    See Also:
    
    Cache2kBuilder.permitNullValues(boolean)
  - isDisableStatistics
```
public boolean isDisableStatistics()
```
  - setDisableStatistics
```
public void setDisableStatistics(boolean v)
```
    See Also:
    
    Cache2kBuilder.disableStatistics(boolean)
  - getEvictionSegmentCount
```
public int getEvictionSegmentCount()
```
  - setEvictionSegmentCount
```
public void setEvictionSegmentCount(int v)
```
    See Also:
    
    Cache2kBuilder.evictionSegmentCount(int)
  - getLoaderExecutor
```
public CustomizationSupplier<Executor> getLoaderExecutor()
```
  - setLoaderExecutor
```
public void setLoaderExecutor(CustomizationSupplier<Executor> v)
```
    See Also:
    
    Cache2kBuilder.loaderExecutor(Executor)
  - getPrefetchExecutor
```
public CustomizationSupplier<Executor> getPrefetchExecutor()
```
  - setPrefetchExecutor
```
public void setPrefetchExecutor(CustomizationSupplier<Executor> v)
```
    See Also:
    
    Cache2kBuilder.prefetchExecutor(Executor)

Class Cache2kConfiguration<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXPIRY_NOT_ETERNAL

Constructor Detail

Cache2kConfiguration

Method Detail

of

of

of

of

getName

setName

getEntryCapacity

setEntryCapacity

isRefreshAhead

setRefreshAhead

isBackgroundRefresh

setBackgroundRefresh

getKeyType

setKeyType

setKeyType

getValueType

setValueType

setValueType

isEternal

setEternal

setExpirySeconds

getExpirySeconds

getExpireAfterWrite

setExpireAfterWrite

getRetryInterval

setRetryInterval

getMaxRetryInterval

setMaxRetryInterval

getResilienceDuration

setResilienceDuration

isKeepDataAfterExpired

setKeepDataAfterExpired

isSharpExpiry

setSharpExpiry

isSuppressExceptions

setSuppressExceptions

isExternalConfigurationPresent

setExternalConfigurationPresent

getSections

getLoader

setLoader

getAdvancedLoader

setAdvancedLoader

getLoaderThreadCount

setLoaderThreadCount

getExpiryPolicy

setExpiryPolicy

getWriter

setWriter

isStoreByReference

setStoreByReference

getExceptionPropagator

setExceptionPropagator

getListeners

hasListeners

getAsyncListeners

hasAsyncListeners

getResiliencePolicy

setResiliencePolicy

isStrictEviction

setStrictEviction

isPermitNullValues

setPermitNullValues

isDisableStatistics

setDisableStatistics

getEvictionSegmentCount

setEvictionSegmentCount

getLoaderExecutor

setLoaderExecutor

getPrefetchExecutor