TriavaCacheConfiguration (triava 2.0.1 API)

Type Parameters:

K - Key type

V - Value type

All Superinterfaces:

javax.cache.configuration.CompleteConfiguration<K,V>, javax.cache.configuration.Configuration<K,V>, Serializable

All Known Implementing Classes:

Builder, InternalBuilder
```
public interface TriavaCacheConfiguration<K,V,B extends TriavaCacheConfiguration<K,V,B>>
extends javax.cache.configuration.CompleteConfiguration<K,V>
```
A Builder to create Cache instances. A Builder instance must be retrieved via a TCacheFactory, to guarantee each created Cache will be registered in a CacheManager (Hint: The TCacheFactory implements CacheManager).

Author:

cesken

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class TriavaCacheConfiguration.PropsType

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TriavaCacheConfiguration.PropsType`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration)`
`Properties`	`asProperties(TriavaCacheConfiguration.PropsType propsType)` Returns a representation of the Configuration as Properties.
`boolean`	`equals(Object obj)`
`Iterable<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>>`	`getCacheEntryListenerConfigurations()`
`javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>>`	`getCacheLoaderFactory()`
`CacheWriteMode`	`getCacheWriteMode()`
`javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>>`	`getCacheWriterFactory()`
`long`	`getCleanUpIntervalMillis()` Returns the proposed cleanup interval in ms.
`int`	`getConcurrencyLevel()`
`EvictionInterface<K,V>`	`getEvictionClass()`
`EvictionPolicy`	`getEvictionPolicy()`
`javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>`	`getExpiryPolicyFactory()`
`HashImplementation`	`getHashImplementation()`
`String`	`getId()`
`JamPolicy`	`getJamPolicy()`
`Class<K>`	`getKeyType()`
`CacheLoader<K,V>`	`getLoader()`
`int`	`getMapConcurrencyLevel()`
`long`	`getMaxCacheTime()`
`long`	`getMaxCacheTimeSpread()`
`int`	`getMaxElements()`
`long`	`getMaxIdleTime()`
`boolean`	`getStatistics()` Returns whether statistics are enabled
`Class<V>`	`getValueType()`
`int`	`hashCode()`
`boolean`	`isManagementEnabled()`
`boolean`	`isReadThrough()`
`boolean`	`isStatisticsEnabled()`
`boolean`	`isStoreByValue()`
`boolean`	`isStrictJSR107()` Returns whether the Cache behaves strictly JSR107 compliant
`boolean`	`isWriteThrough()`
`void`	`removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration)`
`B`	`setCacheLoaderFactory(javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> loaderFactory)`
`B`	`setCacheWriteMode(CacheWriteMode writeMode)`
`B`	`setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K,? super V>> factory)`
`B`	`setCleanupInterval(int cleanupInterval, TimeUnit timeUnit)` Sets the proposed cleanup interval for expiring cache entries.
`B`	`setConcurrencyLevel(int concurrencyLevel)` Sets the expected concurrency level.
`B`	`setEvictionClass(EvictionInterface<K,V> clazz)` Sets a custom eviction policy.
`B`	`setEvictionPolicy(EvictionPolicy evictionPolicy)` Sets the eviction policy, for example LFU or LRU.
`B`	`setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> factory)` Sets the ExpiryPolicyFactory.
`B`	`setHashImplementation(HashImplementation hashImplementation)` Set the StorageBackend for the underlying ConcurrentMap.
`B`	`setId(String id)` Sets the id of this Cache.
`B`	`setJamPolicy(JamPolicy jamPolicy)` Sets the policy, how a Thread that calls put() will behave the cache is full.
`void`	`setKeyType(Class<K> keyType)`
`B`	`setLoader(CacheLoader<K,V> loader)`
`B`	`setManagement(boolean management)` Sets whether management should be enabled.
`B`	`setMaxCacheTime(int maxCacheTime, int interval, TimeUnit timeUnit)` Sets the interval within a cache entry expires.
`B`	`setMaxCacheTime(int maxCacheTime, TimeUnit timeUnit)` Sets the default expiration time for entries in this cache.
`B`	`setMaxElements(int maxElements)` Sets the expected number of elements to be stored.
`B`	`setMaxIdleTime(int maxIdleTime, TimeUnit timeUnit)` Sets the maximum time of an unused (idle) cache entry.
`B`	`setReadThrough(boolean isReadThrough)`
`B`	`setStatistics(boolean statistics)` Sets whether statistics should be gathered.
`void`	`setStrictJSR107(boolean strictJSR107)`
`void`	`setValueType(Class<V> valueType)`
`B`	`setWriteThrough(boolean isWriteThrough)`
`StorageBackend<K,V>`	`storageFactory()`

- Method Detail
  - setId
```
B setId(String id)
```
    Sets the id of this Cache. The id is identical with the JSR107 cache name.
    
    Parameters:
    
    id - The cache name
    
    Returns:
    
    This Builder
  - setMaxIdleTime
```
B setMaxIdleTime(int maxIdleTime,
                 TimeUnit timeUnit)
```
    Sets the maximum time of an unused (idle) cache entry. It will overwrite any values set before via setExpiryPolicyFactory(Factory).
    
    Parameters:
    
    maxIdleTime - The maximum time
    
    timeUnit - The TimeUnit of maxIdleTime
    
    Returns:
    
    This Builder
  - setMaxCacheTime
```
B setMaxCacheTime(int maxCacheTime,
                  int interval,
                  TimeUnit timeUnit)
```
    Sets the interval within a cache entry expires. The value in the interval [maxCacheTime, maxCacheTime+interval] is selected pseudo-randomly for each individual entry put in the cache, unless an explicit expiration time is set in the put() operation.
    This method is useful for mass-inserts in the Cache, that should not expire at the same time (e.g. for resource reasons).
    
    Parameters:
    
    maxCacheTime - The minimum time to keep in seconds
    
    interval - The size of the interval in seconds
    
    timeUnit - The TimeUnit of maxCacheTime and interval
    
    Returns:
    
    This Builder
  - setMaxCacheTime
```
B setMaxCacheTime(int maxCacheTime,
                  TimeUnit timeUnit)
```
    Sets the default expiration time for entries in this cache. All entries use this time, unless it is added using a put method that allows overriding the expiration time, like Cache.put(Object, Object, int, int, TimeUnit).
    
    Parameters:
    
    maxCacheTime - The time to keep the value in seconds
    
    timeUnit - The TimeUnit of maxCacheTime
    
    Returns:
    
    This Builder
  - setCleanupInterval
```
B setCleanupInterval(int cleanupInterval,
                     TimeUnit timeUnit)
```
    Sets the proposed cleanup interval for expiring cache entries. The Cache will use this value when doing batch expiration. Out-of-bound values are auto-tuned by the Cache to sane limits, which are currently between 1 ms and 5 minutes.
    If you do not call this method, the default cleanup interval is used. For JSR107 Caches this is 1 minute. For native Triava Caches this is auto-optimized according to a fraction of getMaxIdleTime().
    
    Parameters:
    
    cleanupInterval - The eviction cleanup interval. 0 means auto-tuning.
    
    timeUnit - The TimeUnit of cleanupInterval
    
    Returns:
    
    This Builder
  - setMaxElements
```
B setMaxElements(int maxElements)
```
    Sets the expected number of elements to be stored. Cache instances with eviction policy will start evicting after reaching getMaxElements(). Cache instances of unlimited size EvictionPolicy.NONE will use this value only as a hint for initially sizing the underlying storage structures.
    
    Parameters:
    
    maxElements - The maximum number of elements to be stored
    
    Returns:
    
    This Builder
  - setConcurrencyLevel
```
B setConcurrencyLevel(int concurrencyLevel)
```
    Sets the expected concurrency level. In other words, the number of application Threads that concurrently write to the Cache. The underlying ConcurrentMap will use the concurrencyLevel to tune its internal data structures for concurrent usage. For example, the Java ConcurrentHashMap uses this value as-is. Default is 14, and the minimum is 8.
    If not set, the default concurrencyLevel is 16, which should usually rarely create thread contention. If running with 12 cores (24 with hyperthreading) chances are not too high for contention. A note from the Java 6 API docs: "overestimates and underestimates within an order of magnitude do not usually have much noticeable impact."
    For example, in a scenario where 150 Threads write concurrently via putIfAbsent(), only 12 Threads will actually run. As concurrencyLevel is 16, threads will usually rarely block. But in case of unlucky hash bucket distribution or if too many Threads get suspended during holding a lock, issues could arise. If the underlying ConcurrentMap uses unfair locks, it might even lead to thread starvation.
    
    Parameters:
    
    concurrencyLevel - The excpected number of application Threads that concurrently write to the Cache
    
    Returns:
    
    This Builder
  - setEvictionPolicy
```
B setEvictionPolicy(EvictionPolicy evictionPolicy)
```
    Sets the eviction policy, for example LFU or LRU.
    If you want to use a custom eviction strategy, use setEvictionClass(EvictionInterface) instead.
    
    Parameters:
    
    evictionPolicy - The EvictionPolicy
    
    Returns:
    
    This Builder
  - setEvictionClass
```
B setEvictionClass(EvictionInterface<K,V> clazz)
```
    Sets a custom eviction policy. This is useful if the value V holds sensible information that can be used for eviction. For example if V is a Session class, it could hold information about the user: Guest users may be evicted before registered users, and the last chosen should be premium users.
    If you want to use a standard eviction strategy like LFU or LRU, use setEvictionPolicy(EvictionPolicy) instead.
    
    Parameters:
    
    clazz - The instance that implements the eviction policy
    
    Returns:
    
    This Builder
  - getEvictionClass
```
EvictionInterface<K,V> getEvictionClass()
```
    Returns:
    
    the evictionClass. null if there is no custom class
  - setHashImplementation
```
B setHashImplementation(HashImplementation hashImplementation)
```
    Set the StorageBackend for the underlying ConcurrentMap. If this method is not called, ConcurrentHashMap will be used.
    
    Parameters:
    
    hashImplementation - The HashImplementation
    
    Returns:
    
    This Builder
  - setJamPolicy
```
B setJamPolicy(JamPolicy jamPolicy)
```
    Sets the policy, how a Thread that calls put() will behave the cache is full. Either the Thread will WAIT or DROP the element and not put it in the cache. The default is WAIT. The JamPolicy has no effect on caches of unlimited size EvictionPolicy}.NONE.
    
    Parameters:
    
    jamPolicy - The JamPolicy
    
    Returns:
    
    This Builder
  - getStatistics
```
boolean getStatistics()
```
    Returns whether statistics are enabled
    
    Returns:
    
    true, if statistics are enabled
  - setStatistics
```
B setStatistics(boolean statistics)
```
    Sets whether statistics should be gathered. The performance impact on creating statistics is very low, so it is safe to activate statistics. If this method is not called, the default is to collect statistics.
    
    Parameters:
    
    statistics - true, if you want to switch on statistics
    
    Returns:
    
    This Builder
  - setManagement
```
B setManagement(boolean management)
```
    Sets whether management should be enabled.
    
    Parameters:
    
    management - true, if you want to switch on management
    
    Returns:
    
    This Builder
  - getId
```
String getId()
```
    Returns:
    
    the id
  - getMaxIdleTime
```
long getMaxIdleTime()
```
    Returns:
    
    the maxIdleTime in milliseconds.
  - getMaxCacheTime
```
long getMaxCacheTime()
```
    Returns:
    
    The lower bound of the "maximum cache time interval" [maxCacheTime, maxCacheTime+maxCacheTimeSpread] in milliseconds.
  - getMaxCacheTimeSpread
```
long getMaxCacheTimeSpread()
```
    Returns:
    
    The interval size of the cache time interval in milliseconds.
  - getCleanUpIntervalMillis
```
long getCleanUpIntervalMillis()
```
    Returns the proposed cleanup interval in ms. See setCleanupInterval(int, TimeUnit) for details on how the Cache uses this value.
    
    Returns:
    
    The proposed cleanup interval in ms. 0 means auto-tuning
  - getMaxElements
```
int getMaxElements()
```
    Returns:
    
    the maximum number of elements.
    
    See Also:
    
    setMaxElements(int)
  - getConcurrencyLevel
```
int getConcurrencyLevel()
```
    Returns:
    
    the concurrencyLevel
  - getMapConcurrencyLevel
```
int getMapConcurrencyLevel()
```
  - getEvictionPolicy
```
EvictionPolicy getEvictionPolicy()
```
    Returns:
    
    the evictionPolicy
  - getHashImplementation
```
HashImplementation getHashImplementation()
```
    Returns:
    
    the hashImplementation
  - storageFactory
```
StorageBackend<K,V> storageFactory()
```
  - getJamPolicy
```
JamPolicy getJamPolicy()
```
  - getKeyType
```
Class<K> getKeyType()
```
    Specified by:
    
    getKeyType in interface javax.cache.configuration.Configuration<K,V>
  - getValueType
```
Class<V> getValueType()
```
    Specified by:
    
    getValueType in interface javax.cache.configuration.Configuration<K,V>
  - setKeyType
```
void setKeyType(Class<K> keyType)
```
    Parameters:
    
    keyType - the required key type
    
    See Also:
    
    getKeyType()
  - setValueType
```
void setValueType(Class<V> valueType)
```
    Parameters:
    
    valueType - the required value type
    
    See Also:
    
    getValueType()
  - isStoreByValue
```
boolean isStoreByValue()
```
    Specified by:
    
    isStoreByValue in interface javax.cache.configuration.Configuration<K,V>
  - getCacheWriteMode
```
CacheWriteMode getCacheWriteMode()
```
  - setCacheWriteMode
```
B setCacheWriteMode(CacheWriteMode writeMode)
```
  - asProperties
```
Properties asProperties(TriavaCacheConfiguration.PropsType propsType)
```
    Returns a representation of the Configuration as Properties. The returned properties are a private copy for the caller and thus not shared amongst different callers. Changes to the returned Properties have no effect on the Cache.
    
    Parameters:
    
    propsType - If PropsType.CacheManager, the Cache specific properties (cacheName, cacheLoaderClass) are excluded
    
    Returns:
    
    The current configuration
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - setLoader
```
B setLoader(CacheLoader<K,V> loader)
```
  - setCacheLoaderFactory
```
B setCacheLoaderFactory(javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> loaderFactory)
```
  - setCacheWriterFactory
```
B setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K,? super V>> factory)
```
  - setReadThrough
```
B setReadThrough(boolean isReadThrough)
```
  - setWriteThrough
```
B setWriteThrough(boolean isWriteThrough)
```
  - getLoader
```
CacheLoader<K,V> getLoader()
```
  - getCacheLoaderFactory
```
javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> getCacheLoaderFactory()
```
    Specified by:
    
    getCacheLoaderFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - getCacheWriterFactory
```
javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>> getCacheWriterFactory()
```
    Specified by:
    
    getCacheWriterFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - isReadThrough
```
boolean isReadThrough()
```
    Specified by:
    
    isReadThrough in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - isWriteThrough
```
boolean isWriteThrough()
```
    Specified by:
    
    isWriteThrough in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - isStatisticsEnabled
```
boolean isStatisticsEnabled()
```
    Specified by:
    
    isStatisticsEnabled in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - isManagementEnabled
```
boolean isManagementEnabled()
```
    Specified by:
    
    isManagementEnabled in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - isStrictJSR107
```
boolean isStrictJSR107()
```
    Returns whether the Cache behaves strictly JSR107 compliant
    
    Returns:
    
    true if the Cache behaves strictly JSR107 compliant
  - setStrictJSR107
```
void setStrictJSR107(boolean strictJSR107)
```
  - getCacheEntryListenerConfigurations
```
Iterable<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>> getCacheEntryListenerConfigurations()
```
    Specified by:
    
    getCacheEntryListenerConfigurations in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - getExpiryPolicyFactory
```
javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> getExpiryPolicyFactory()
```
    Specified by:
    
    getExpiryPolicyFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>
  - setExpiryPolicyFactory
```
B setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> factory)
```
    Sets the ExpiryPolicyFactory. It will overwrite any values set before via setMaxIdleTime(int, TimeUnit).
    
    Parameters:
    
    factory - The factory
    
    Returns:
    
    This Builder
  - addCacheEntryListenerConfiguration
```
void addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration)
```
  - removeCacheEntryListenerConfiguration
```
void removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration)
```

Interface TriavaCacheConfiguration<K,V,B extends TriavaCacheConfiguration<K,V,B>>

Nested Class Summary

Method Summary

Method Detail

setId

setMaxIdleTime

setMaxCacheTime

setMaxCacheTime

setCleanupInterval

setMaxElements

setConcurrencyLevel

setEvictionPolicy

setEvictionClass

getEvictionClass

setHashImplementation

setJamPolicy

getStatistics

setStatistics

setManagement

getId

getMaxIdleTime

getMaxCacheTime

getMaxCacheTimeSpread

getCleanUpIntervalMillis

getMaxElements

getConcurrencyLevel

getMapConcurrencyLevel

getEvictionPolicy

getHashImplementation

storageFactory

getJamPolicy

getKeyType

getValueType

setKeyType

setValueType

isStoreByValue

getCacheWriteMode

setCacheWriteMode

asProperties

hashCode

equals

setLoader

setCacheLoaderFactory

setCacheWriterFactory

setReadThrough

setWriteThrough

getLoader

getCacheLoaderFactory

getCacheWriterFactory

isReadThrough

isWriteThrough

isStatisticsEnabled

isManagementEnabled

isStrictJSR107

setStrictJSR107

getCacheEntryListenerConfigurations

getExpiryPolicyFactory

setExpiryPolicyFactory

addCacheEntryListenerConfiguration

removeCacheEntryListenerConfiguration