Class CaffeineConfiguration<K,V>

java.lang.Object

com.github.benmanes.caffeine.jcache.configuration.CaffeineConfiguration<K,V>

All Implemented Interfaces:

Serializable, CompleteConfiguration<K,V>, Configuration<K,V>

@NullMarked
public final class CaffeineConfiguration<K,V>
extends Object
implements CompleteConfiguration<K,V>

A JCache configuration with Caffeine specific settings.

The initial settings disable store by value so that entries are not copied when crossing the Cache API boundary. If enabled and the Copier is not explicitly set, then the JavaSerializationCopier will be used. This differs from MutableConfiguration which enables store by value at construction.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CaffeineConfiguration()
CaffeineConfiguration(CompleteConfiguration<K,V> configuration)	Returns a modifiable copy of the configuration.

Method Summary

Modifier and Type	Method	Description
CaffeineConfiguration<K,V>	addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)	See MutableConfiguration.addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>).
boolean	equals(@Nullable Object o)
Iterable<CacheEntryListenerConfiguration<K,V>>	getCacheEntryListenerConfigurations()
@Nullable Factory<CacheLoader<K,V>>	getCacheLoaderFactory()
@Nullable CacheWriter<K,V>	getCacheWriter()	Returns a writer created by the configured factory or null if not set.
@Nullable Factory<CacheWriter<? super K, ? super V>>	getCacheWriterFactory()
Factory<Copier>	getCopierFactory()	Returns the Factory for the Copier to be used for the cache.
Factory<Executor>	getExecutorFactory()	Returns the Factory for the Executor to be used for the cache.
OptionalLong	getExpireAfterAccess()	Returns the expire after access in nanoseconds.
OptionalLong	getExpireAfterWrite()	Returns the expire after write in nanoseconds.
Optional<Factory<Expiry<K,V>>>	getExpiryFactory()	Returns the Factory for the Expiry to be used for the cache.
Factory<ExpiryPolicy>	getExpiryPolicyFactory()
Class<K>	getKeyType()
OptionalLong	getMaximumSize()	Returns the maximum size to be used for the cache.
OptionalLong	getMaximumWeight()	Returns the maximum weight to be used for the cache.
OptionalLong	getRefreshAfterWrite()	Returns the refresh after write in nanoseconds.
Factory<Scheduler>	getSchedulerFactory()	Returns the Factory for the Scheduler to be used for the cache.
Factory<Ticker>	getTickerFactory()	Returns the Factory for the Ticker to be used for the cache.
Class<V>	getValueType()
Optional<Factory<Weigher<K,V>>>	getWeigherFactory()	Returns the Factory for the Weigher to be used for the cache.
boolean	hasCacheWriter()	Returns if the cache writer factory is specified.
int	hashCode()
CaffeineConfiguration<K,V>	immutableCopy()	Returns an unmodifiable copy of this configuration.
boolean	isManagementEnabled()	See CompleteConfiguration.isManagementEnabled().
boolean	isNativeStatisticsEnabled()	Checks whether native statistics collection is enabled in this cache.
boolean	isReadThrough()
boolean	isStatisticsEnabled()
boolean	isStoreByValue()
boolean	isWriteThrough()
CaffeineConfiguration<K,V>	removeCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)	See MutableConfiguration.removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>).
CaffeineConfiguration<K,V>	setCacheLoaderFactory(@Nullable Factory<? extends CacheLoader<K,V>> factory)	See MutableConfiguration.setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K, V>>).
CaffeineConfiguration<K,V>	setCacheWriterFactory(@Nullable Factory<? extends CacheWriter<? super K, ? super V>> factory)	See MutableConfiguration.setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K, ? super V>>).
CaffeineConfiguration<K,V>	setCopierFactory(Factory<Copier> factory)	Set the Factory for the Copier.
CaffeineConfiguration<K,V>	setExecutorFactory(Factory<Executor> factory)	Set the Factory for the Executor.
CaffeineConfiguration<K,V>	setExpireAfterAccess(OptionalLong expireAfterAccessNanos)	Set the expire after write in nanoseconds.
CaffeineConfiguration<K,V>	setExpireAfterWrite(OptionalLong expireAfterWriteNanos)	Set the expire after write in nanoseconds.
CaffeineConfiguration<K,V>	setExpiryFactory(Optional<Factory<? extends Expiry<K,V>>> factory)	Set the Factory for the Expiry.
CaffeineConfiguration<K,V>	setExpiryPolicyFactory(@Nullable Factory<? extends ExpiryPolicy> factory)	See MutableConfiguration.setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy>).
CaffeineConfiguration<K,V>	setManagementEnabled(boolean enabled)	See MutableConfiguration.setManagementEnabled(boolean).
CaffeineConfiguration<K,V>	setMaximumSize(OptionalLong maximumSize)	Set the maximum size.
CaffeineConfiguration<K,V>	setMaximumWeight(OptionalLong maximumWeight)	Set the maximum weight.
CaffeineConfiguration<K,V>	setNativeStatisticsEnabled(boolean enabled)	Sets whether native statistics gathering is enabled on a cache.
CaffeineConfiguration<K,V>	setReadThrough(boolean isReadThrough)	See MutableConfiguration.setReadThrough(boolean).
CaffeineConfiguration<K,V>	setRefreshAfterWrite(OptionalLong refreshAfterWriteNanos)	Set the refresh after write in nanoseconds.
CaffeineConfiguration<K,V>	setSchedulerFactory(Factory<Scheduler> factory)	Set the Factory for the Scheduler.
CaffeineConfiguration<K,V>	setStatisticsEnabled(boolean enabled)	See MutableConfiguration.setStatisticsEnabled(boolean).
CaffeineConfiguration<K,V>	setStoreByValue(boolean isStoreByValue)	See MutableConfiguration.setStoreByValue(boolean).
CaffeineConfiguration<K,V>	setTickerFactory(Factory<Ticker> factory)	Set the Factory for the Ticker.
CaffeineConfiguration<K,V>	setTypes(Class<K> keyType, Class<V> valueType)	See MutableConfiguration.setTypes(java.lang.Class<K>, java.lang.Class<V>).
CaffeineConfiguration<K,V>	setWeigherFactory(Optional<Factory<? extends Weigher<K,V>>> factory)	Set the Factory for the Weigher.
CaffeineConfiguration<K,V>	setWriteThrough(boolean isWriteThrough)	See MutableConfiguration.setWriteThrough(boolean).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CaffeineConfiguration

public CaffeineConfiguration()

CaffeineConfiguration

public CaffeineConfiguration(CompleteConfiguration<K,V> configuration)

Returns a modifiable copy of the configuration.

Method Details

immutableCopy

public CaffeineConfiguration<K,V> immutableCopy()

Returns an unmodifiable copy of this configuration.

getKeyType

public Class<K> getKeyType()

Specified by:

getKeyType in interface Configuration<K,V>

getValueType

public Class<V> getValueType()

Specified by:

getValueType in interface Configuration<K,V>

setTypes

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setTypes(Class<K> keyType,
 Class<V> valueType)

See MutableConfiguration.setTypes(java.lang.Class<K>, java.lang.Class<V>).

getCacheEntryListenerConfigurations

public Iterable<CacheEntryListenerConfiguration<K,V>> getCacheEntryListenerConfigurations()

Specified by:

getCacheEntryListenerConfigurations in interface CompleteConfiguration<K,V>

addCacheEntryListenerConfiguration

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

See MutableConfiguration.addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>).

removeCacheEntryListenerConfiguration

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> removeCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

See MutableConfiguration.removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>).

getCacheLoaderFactory

public @Nullable Factory<CacheLoader<K,V>> getCacheLoaderFactory()

Specified by:

getCacheLoaderFactory in interface CompleteConfiguration<K,V>

setCacheLoaderFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setCacheLoaderFactory(@Nullable Factory<? extends CacheLoader<K,V>> factory)

See MutableConfiguration.setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K, V>>).

getCacheWriterFactory

public @Nullable Factory<CacheWriter<? super K, ? super V>> getCacheWriterFactory()

Specified by:

getCacheWriterFactory in interface CompleteConfiguration<K,V>

getCacheWriter

public @Nullable CacheWriter<K,V> getCacheWriter()

Returns a writer created by the configured factory or null if not set.

hasCacheWriter

public boolean hasCacheWriter()

Returns if the cache writer factory is specified.

setCacheWriterFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setCacheWriterFactory(@Nullable Factory<? extends CacheWriter<? super K, ? super V>> factory)

See MutableConfiguration.setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K, ? super V>>).

getExpiryPolicyFactory

public Factory<ExpiryPolicy> getExpiryPolicyFactory()

Specified by:

getExpiryPolicyFactory in interface CompleteConfiguration<K,V>

setExpiryPolicyFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setExpiryPolicyFactory(@Nullable Factory<? extends ExpiryPolicy> factory)

See MutableConfiguration.setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy>).

isReadThrough

public boolean isReadThrough()

Specified by:

isReadThrough in interface CompleteConfiguration<K,V>

setReadThrough

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setReadThrough(boolean isReadThrough)

See MutableConfiguration.setReadThrough(boolean).

isWriteThrough

public boolean isWriteThrough()

Specified by:

isWriteThrough in interface CompleteConfiguration<K,V>

setWriteThrough

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setWriteThrough(boolean isWriteThrough)

See MutableConfiguration.setWriteThrough(boolean).

isStoreByValue

public boolean isStoreByValue()

Specified by:

isStoreByValue in interface Configuration<K,V>

setStoreByValue

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setStoreByValue(boolean isStoreByValue)

See MutableConfiguration.setStoreByValue(boolean).

isNativeStatisticsEnabled

public boolean isNativeStatisticsEnabled()

Checks whether native statistics collection is enabled in this cache.

The default value is false.

Returns:

true if native statistics collection is enabled

setNativeStatisticsEnabled

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setNativeStatisticsEnabled(boolean enabled)

Sets whether native statistics gathering is enabled on a cache.

Parameters:

enabled - true to enable native statistics, false to disable.

Returns:

the CaffeineConfiguration to permit fluent-style method calls

isStatisticsEnabled

public boolean isStatisticsEnabled()

Specified by:

isStatisticsEnabled in interface CompleteConfiguration<K,V>

setStatisticsEnabled

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setStatisticsEnabled(boolean enabled)

See MutableConfiguration.setStatisticsEnabled(boolean).

isManagementEnabled

public boolean isManagementEnabled()

See CompleteConfiguration.isManagementEnabled().

Specified by:

isManagementEnabled in interface CompleteConfiguration<K,V>

setManagementEnabled

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setManagementEnabled(boolean enabled)

See MutableConfiguration.setManagementEnabled(boolean).

getCopierFactory

public Factory<Copier> getCopierFactory()

Returns the Factory for the Copier to be used for the cache.

Returns:

the Factory for the Copier

setCopierFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setCopierFactory(Factory<Copier> factory)

Set the Factory for the Copier.

Parameters:

factory - the Copier Factory

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getSchedulerFactory

public Factory<Scheduler> getSchedulerFactory()

Returns the Factory for the Scheduler to be used for the cache.

Returns:

the Factory for the Scheduler

setSchedulerFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setSchedulerFactory(Factory<Scheduler> factory)

Set the Factory for the Scheduler.

Parameters:

factory - the Scheduler Factory

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getTickerFactory

public Factory<Ticker> getTickerFactory()

Returns the Factory for the Ticker to be used for the cache.

Returns:

the Factory for the Ticker

setTickerFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setTickerFactory(Factory<Ticker> factory)

Set the Factory for the Ticker.

Parameters:

factory - the Ticker Factory

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getExecutorFactory

public Factory<Executor> getExecutorFactory()

Returns the Factory for the Executor to be used for the cache.

Returns:

the Factory for the Executor

setExecutorFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setExecutorFactory(Factory<Executor> factory)

Set the Factory for the Executor.

Parameters:

factory - the Executor Factory

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getRefreshAfterWrite

public OptionalLong getRefreshAfterWrite()

Returns the refresh after write in nanoseconds.

Returns:

the duration in nanoseconds

setRefreshAfterWrite

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setRefreshAfterWrite(OptionalLong refreshAfterWriteNanos)

Set the refresh after write in nanoseconds.

Parameters:

refreshAfterWriteNanos - the duration in nanoseconds

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getExpireAfterWrite

public OptionalLong getExpireAfterWrite()

Returns the expire after write in nanoseconds.

Returns:

the duration in nanoseconds

setExpireAfterWrite

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setExpireAfterWrite(OptionalLong expireAfterWriteNanos)

Set the expire after write in nanoseconds.

Parameters:

expireAfterWriteNanos - the duration in nanoseconds

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getExpireAfterAccess

public OptionalLong getExpireAfterAccess()

Returns the expire after access in nanoseconds.

Returns:

the duration in nanoseconds

setExpireAfterAccess

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setExpireAfterAccess(OptionalLong expireAfterAccessNanos)

Set the expire after write in nanoseconds.

Parameters:

expireAfterAccessNanos - the duration in nanoseconds

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getExpiryFactory

public Optional<Factory<Expiry<K,V>>> getExpiryFactory()

Returns the Factory for the Expiry to be used for the cache.

Returns:

the Factory for the Expiry

setExpiryFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setExpiryFactory(Optional<Factory<? extends Expiry<K,V>>> factory)

Set the Factory for the Expiry.

Parameters:

factory - the Expiry Factory

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getMaximumSize

public OptionalLong getMaximumSize()

Returns the maximum size to be used for the cache.

Returns:

the maximum size

setMaximumSize

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setMaximumSize(OptionalLong maximumSize)

Set the maximum size.

Parameters:

maximumSize - the maximum size

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getMaximumWeight

public OptionalLong getMaximumWeight()

Returns the maximum weight to be used for the cache.

Returns:

the maximum weight

setMaximumWeight

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setMaximumWeight(OptionalLong maximumWeight)

Set the maximum weight.

Parameters:

maximumWeight - the maximum weighted size

Returns:

the CaffeineConfiguration to permit fluent-style method calls

getWeigherFactory

public Optional<Factory<Weigher<K,V>>> getWeigherFactory()

Returns the Factory for the Weigher to be used for the cache.

Returns:

the Factory for the Weigher

setWeigherFactory

@CanIgnoreReturnValue
public CaffeineConfiguration<K,V> setWeigherFactory(Optional<Factory<? extends Weigher<K,V>>> factory)

Set the Factory for the Weigher.

Parameters:

factory - the Weigher Factory

Returns:

the CaffeineConfiguration to permit fluent-style method calls

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object