CaffeineConfiguration (jcache 2.9.3 API)

java.lang.Object
- com.github.benmanes.caffeine.jcache.configuration.CaffeineConfiguration<K,V>

All Implemented Interfaces:

Serializable, CompleteConfiguration<K,V>, Configuration<K,V>
```
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 and Description

CaffeineConfiguration()

CaffeineConfiguration(CompleteConfiguration<K,V> configuration)

Constructors
Constructor and Description
`CaffeineConfiguration()`
`CaffeineConfiguration(CompleteConfiguration<K,V> configuration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)` See `MutableConfiguration.addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>)`.
`boolean`	`equals(Object o)`
`Iterable<CacheEntryListenerConfiguration<K,V>>`	`getCacheEntryListenerConfigurations()`
`Factory<CacheLoader<K,V>>`	`getCacheLoaderFactory()`
`@Nullable CacheWriter<K,V>`	`getCacheWriter()`
`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()`
`int`	`hashCode()`
`boolean`	`isManagementEnabled()` See `MutableConfiguration.isManagementEnabled`.
`boolean`	`isNativeStatisticsEnabled()` Checks whether native statistics collection is enabled in this cache.
`boolean`	`isReadThrough()`
`boolean`	`isStatisticsEnabled()`
`boolean`	`isStoreByValue()`
`boolean`	`isWriteThrough()`
`void`	`removeCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)` See `MutableConfiguration.removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>)`.
`void`	`setCacheLoaderFactory(Factory<? extends CacheLoader<K,V>> factory)` See `MutableConfiguration.setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K, V>>)`.
`void`	`setCacheWriterFactory(Factory<? extends CacheWriter<? super K,? super V>> factory)` See `MutableConfiguration.setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K, ? super V>>)`.
`void`	`setCopierFactory(Factory<Copier> factory)` Set the `Factory` for the `Copier`.
`void`	`setExecutorFactory(Factory<Executor> factory)` Set the `Factory` for the `Executor`.
`void`	`setExpireAfterAccess(OptionalLong expireAfterAccessNanos)` Set the expire after write in nanoseconds.
`void`	`setExpireAfterWrite(OptionalLong expireAfterWriteNanos)` Set the expire after write in nanoseconds.
`void`	`setExpiryFactory(Optional<Factory<? extends Expiry<K,V>>> factory)` Set the `Factory` for the `Expiry`.
`void`	`setExpiryPolicyFactory(Factory<? extends ExpiryPolicy> factory)` See `MutableConfiguration.setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy>)`.
`void`	`setManagementEnabled(boolean enabled)` See `MutableConfiguration.setManagementEnabled(boolean)`.
`void`	`setMaximumSize(OptionalLong maximumSize)` Set the maximum size.
`void`	`setMaximumWeight(OptionalLong maximumWeight)` Set the maximum weight.
`void`	`setNativeStatisticsEnabled(boolean enabled)` Sets whether native statistics gathering is enabled on a cache.
`void`	`setReadThrough(boolean isReadThrough)` See `MutableConfiguration.setReadThrough(boolean)`.
`void`	`setRefreshAfterWrite(OptionalLong refreshAfterWriteNanos)` Set the refresh after write in nanoseconds.
`void`	`setSchedulerFactory(Factory<Scheduler> factory)` Set the `Factory` for the `Scheduler`.
`void`	`setStatisticsEnabled(boolean enabled)` See `MutableConfiguration.setStatisticsEnabled(boolean)`.
`void`	`setStoreByValue(boolean isStoreByValue)` See `MutableConfiguration.setStoreByValue(boolean)`.
`void`	`setTickerFactory(Factory<Ticker> factory)` Set the `Factory` for the `Ticker`.
`void`	`setTypes(Class<K> keyType, Class<V> valueType)` See `MutableConfiguration.setTypes(java.lang.Class<K>, java.lang.Class<V>)`.
`void`	`setWeigherFactory(Optional<Factory<? extends Weigher<K,V>>> factory)` Set the `Factory` for the `Weigher`.
`void`	`setWriteThrough(boolean isWriteThrough)` See `MutableConfiguration.setWriteThrough(boolean)`.

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

- Constructor Detail
  - CaffeineConfiguration
```
public CaffeineConfiguration()
```
  - CaffeineConfiguration
```
public CaffeineConfiguration(CompleteConfiguration<K,V> configuration)
```
- Method Detail
  - 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
```
public void 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
```
public void addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
    See MutableConfiguration.addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>).
  - removeCacheEntryListenerConfiguration
```
public void removeCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
    See MutableConfiguration.removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K, V>).
  - getCacheLoaderFactory
```
public Factory<CacheLoader<K,V>> getCacheLoaderFactory()
```
    Specified by:
    
    getCacheLoaderFactory in interface CompleteConfiguration<K,V>
  - setCacheLoaderFactory
```
public void setCacheLoaderFactory(Factory<? extends CacheLoader<K,V>> factory)
```
    See MutableConfiguration.setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K, V>>).
  - getCacheWriterFactory
```
public 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
```
public void setCacheWriterFactory(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
```
public void setExpiryPolicyFactory(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
```
public void setReadThrough(boolean isReadThrough)
```
    See MutableConfiguration.setReadThrough(boolean).
  - isWriteThrough
```
public boolean isWriteThrough()
```
    Specified by:
    
    isWriteThrough in interface CompleteConfiguration<K,V>
  - setWriteThrough
```
public void setWriteThrough(boolean isWriteThrough)
```
    See MutableConfiguration.setWriteThrough(boolean).
  - isStoreByValue
```
public boolean isStoreByValue()
```
    Specified by:
    
    isStoreByValue in interface Configuration<K,V>
  - setStoreByValue
```
public void 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
```
public void setNativeStatisticsEnabled(boolean enabled)
```
    Sets whether native statistics gathering is enabled on a cache.
    
    Parameters:
    
    enabled - true to enable native statistics, false to disable.
  - isStatisticsEnabled
```
public boolean isStatisticsEnabled()
```
    Specified by:
    
    isStatisticsEnabled in interface CompleteConfiguration<K,V>
  - setStatisticsEnabled
```
public void setStatisticsEnabled(boolean enabled)
```
    See MutableConfiguration.setStatisticsEnabled(boolean).
  - isManagementEnabled
```
public boolean isManagementEnabled()
```
    See MutableConfiguration.isManagementEnabled.
    
    Specified by:
    
    isManagementEnabled in interface CompleteConfiguration<K,V>
  - setManagementEnabled
```
public void 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
```
public void setCopierFactory(Factory<Copier> factory)
```
    Set the Factory for the Copier.
    
    Parameters:
    
    factory - the Copier Factory
  - getSchedulerFactory
```
public Factory<Scheduler> getSchedulerFactory()
```
    Returns the Factory for the Scheduler to be used for the cache.
    
    Returns:
    
    the Factory for the Scheduler
  - setSchedulerFactory
```
public void setSchedulerFactory(Factory<Scheduler> factory)
```
    Set the Factory for the Scheduler.
    
    Parameters:
    
    factory - the Scheduler Factory
  - getTickerFactory
```
public Factory<Ticker> getTickerFactory()
```
    Returns the Factory for the Ticker to be used for the cache.
    
    Returns:
    
    the Factory for the Ticker
  - setTickerFactory
```
public void setTickerFactory(Factory<Ticker> factory)
```
    Set the Factory for the Ticker.
    
    Parameters:
    
    factory - the Ticker Factory
  - getExecutorFactory
```
public Factory<Executor> getExecutorFactory()
```
    Returns the Factory for the Executor to be used for the cache.
    
    Returns:
    
    the Factory for the Executor
  - setExecutorFactory
```
public void setExecutorFactory(Factory<Executor> factory)
```
    Set the Factory for the Executor.
    
    Parameters:
    
    factory - the Executor Factory
  - getRefreshAfterWrite
```
public OptionalLong getRefreshAfterWrite()
```
    Returns the refresh after write in nanoseconds.
    
    Returns:
    
    the duration in nanoseconds
  - setRefreshAfterWrite
```
public void setRefreshAfterWrite(OptionalLong refreshAfterWriteNanos)
```
    Set the refresh after write in nanoseconds.
    
    Parameters:
    
    refreshAfterWriteNanos - the duration in nanoseconds
  - getExpireAfterWrite
```
public OptionalLong getExpireAfterWrite()
```
    Returns the expire after write in nanoseconds.
    
    Returns:
    
    the duration in nanoseconds
  - setExpireAfterWrite
```
public void setExpireAfterWrite(OptionalLong expireAfterWriteNanos)
```
    Set the expire after write in nanoseconds.
    
    Parameters:
    
    expireAfterWriteNanos - the duration in nanoseconds
  - getExpireAfterAccess
```
public OptionalLong getExpireAfterAccess()
```
    Returns the expire after access in nanoseconds.
    
    Returns:
    
    the duration in nanoseconds
  - setExpireAfterAccess
```
public void setExpireAfterAccess(OptionalLong expireAfterAccessNanos)
```
    Set the expire after write in nanoseconds.
    
    Parameters:
    
    expireAfterAccessNanos - the duration in nanoseconds
  - 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
```
public void setExpiryFactory(Optional<Factory<? extends Expiry<K,V>>> factory)
```
    Set the Factory for the Expiry.
    
    Parameters:
    
    factory - the Expiry Factory
  - setMaximumSize
```
public void setMaximumSize(OptionalLong maximumSize)
```
    Set the maximum size.
    
    Parameters:
    
    maximumSize - the maximum size
  - getMaximumSize
```
public OptionalLong getMaximumSize()
```
    Returns the maximum size to be used for the cache.
    
    Returns:
    
    the maximum size
  - setMaximumWeight
```
public void setMaximumWeight(OptionalLong maximumWeight)
```
    Set the maximum weight.
    
    Parameters:
    
    maximumWeight - the maximum weighted size
  - getMaximumWeight
```
public OptionalLong getMaximumWeight()
```
    Returns the maximum weight to be used for the cache.
    
    Returns:
    
    the maximum weight
  - 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
```
public void setWeigherFactory(Optional<Factory<? extends Weigher<K,V>>> factory)
```
    Set the Factory for the Weigher.
    
    Parameters:
    
    factory - the Weigher Factory
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CaffeineConfiguration<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaffeineConfiguration

CaffeineConfiguration

Method Detail

getKeyType

getValueType

setTypes

getCacheEntryListenerConfigurations

addCacheEntryListenerConfiguration

removeCacheEntryListenerConfiguration

getCacheLoaderFactory

setCacheLoaderFactory

getCacheWriterFactory

getCacheWriter

hasCacheWriter

setCacheWriterFactory

getExpiryPolicyFactory

setExpiryPolicyFactory

isReadThrough

setReadThrough

isWriteThrough

setWriteThrough

isStoreByValue

setStoreByValue

isNativeStatisticsEnabled

setNativeStatisticsEnabled

isStatisticsEnabled

setStatisticsEnabled

isManagementEnabled

setManagementEnabled

getCopierFactory

setCopierFactory

getSchedulerFactory

setSchedulerFactory

getTickerFactory

setTickerFactory

getExecutorFactory

setExecutorFactory

getRefreshAfterWrite

setRefreshAfterWrite

getExpireAfterWrite

setExpireAfterWrite

getExpireAfterAccess

setExpireAfterAccess

getExpiryFactory

setExpiryFactory

setMaximumSize

getMaximumSize

setMaximumWeight

getMaximumWeight

getWeigherFactory

setWeigherFactory

equals

hashCode