CacheConfig (cache2k API only package 0.21 API)

java.lang.Object
- org.cache2k.CacheConfig

```
public class CacheConfig
extends Object
```
Cache configuration. Adheres to bean standard.

Author:

Jens Wilke; created: 2013-06-25

Constructor Summary

Constructors
Constructor and Description

CacheConfig()

Constructors
Constructor and Description
`CacheConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`Class<?>`	`getEntryType()`
`long`	`getExceptionExpiryMillis()`
`long`	`getExpiryMillis()`
`int`	`getExpirySeconds()`
`int`	`getHeapEntryCapacity()`
`Class<?>`	`getImplementation()`
`Class<?>`	`getKeyType()`
`int`	`getMaxSize()`
`int`	`getMaxSizeHighBound()`
`int`	`getMaxSizeLowBound()`
`List<Object>`	`getModuleConfiguration()`
`String`	`getName()`
`List<StorageConfiguration>`	`getStorageModules()`
`Class<?>`	`getValueType()`
`boolean`	`isBackgroundRefresh()`
`boolean`	`isEternal()`
`boolean`	`isKeepDataAfterExpired()`
`boolean`	`isSharpExpiry()`
`boolean`	`isSuppressExceptions()`
`void`	`setBackgroundRefresh(boolean backgroundRefresh)`
`void`	`setEntryType(Class<?> entryType)`
`void`	`setEternal(boolean v)` Set cache entry don't expiry by time.
`void`	`setExceptionExpiryMillis(long v)`
`void`	`setExpiryMillis(long expiryMillis)` The expiry value of all entries.
`void`	`setExpirySeconds(int v)`
`void`	`setHeapEntryCapacity(int v)` Maximum number of entries that the cache keeps in the heap.
`void`	`setImplementation(Class<?> cacheImplementation)`
`void`	`setKeepDataAfterExpired(boolean v)` Expired data is kept in the cache until the entry is evicted by the replacement algorithm.
`void`	`setKeyType(Class<?> keyType)`
`void`	`setMaxSize(int maxSize)`
`void`	`setMaxSizeHighBound(int maxSizeHighBound)`
`void`	`setMaxSizeLowBound(int maxSizeLowBound)`
`void`	`setModuleConfiguration(List<Object> moduleConfiguration)`
`void`	`setName(String name)` Sets the name of a cache.
`void`	`setSharpExpiry(boolean sharpExpiry)`
`void`	`setSuppressExceptions(boolean suppressExceptions)`
`void`	`setValueType(Class<?> valueType)`

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

- Constructor Detail
  - CacheConfig
```
public CacheConfig()
```
- Method Detail
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
    Sets the name of a cache. If a name is not specified the caching framework provides a name for the cache.
    If a name is specified it must be ensured it is unique within the cache manager. A unique name may consist of a namespace and a counter, e.g. "com.company.application.AssetCache-1".
    Allowed characters for a cache name, are URL non-reserved characters, these are: [A-Z], [a-z], [0-9] and [~-_.-], see RFC3986. The reason for restricting the characters in names, is that the names may be used to derive other resource names from it, e.g. for file based storage.
    For brevity within log messages and other displays the cache name may be shortened if the manager name is included as prefix.
  - getMaxSize
```
public int getMaxSize()
```
  - setMaxSize
```
public void setMaxSize(int maxSize)
```
  - getMaxSizeHighBound
```
public int getMaxSizeHighBound()
```
  - setMaxSizeHighBound
```
public void setMaxSizeHighBound(int maxSizeHighBound)
```
  - getMaxSizeLowBound
```
public int getMaxSizeLowBound()
```
  - setMaxSizeLowBound
```
public void setMaxSizeLowBound(int maxSizeLowBound)
```
  - isBackgroundRefresh
```
public boolean isBackgroundRefresh()
```
  - setBackgroundRefresh
```
public void setBackgroundRefresh(boolean backgroundRefresh)
```
  - getKeyType
```
public Class<?> getKeyType()
```
  - setKeyType
```
public void setKeyType(Class<?> keyType)
```
  - getValueType
```
public Class<?> getValueType()
```
  - getEntryType
```
public Class<?> getEntryType()
```
  - setEntryType
```
public void setEntryType(Class<?> entryType)
```
  - setValueType
```
public void setValueType(Class<?> valueType)
```
  - isEternal
```
public boolean isEternal()
```
  - setEternal
```
public void setEternal(boolean v)
```
    Set cache entry don't expiry by time.
  - setExpirySeconds
```
public void setExpirySeconds(int v)
```
  - getExpirySeconds
```
public int getExpirySeconds()
```
  - getExpiryMillis
```
public long getExpiryMillis()
```
  - setExpiryMillis
```
public void setExpiryMillis(long expiryMillis)
```
    The expiry value of all entries. If an entry specific expiry calculation is determined this is the maximum expiry time. A value of -1 switches expiry off, that means entries are kept for an eternal time, a value of 0 switches caching off.
  - getExceptionExpiryMillis
```
public long getExceptionExpiryMillis()
```
  - setExceptionExpiryMillis
```
public void setExceptionExpiryMillis(long v)
```
    See Also:
    CacheBuilder.exceptionExpiryDuration(long, java.util.concurrent.TimeUnit)
  - isKeepDataAfterExpired
```
public boolean isKeepDataAfterExpired()
```
  - setKeepDataAfterExpired
```
public void setKeepDataAfterExpired(boolean v)
```
    Expired data is kept in the cache until the entry is evicted by the replacement algorithm. This consumes memory, but if the data is accessed again the previous data can be used by the cache source for optimizing, e.g. for a get if-modified-since.
    
    See Also:
    CacheSourceWithMetaInfo
  - isSharpExpiry
```
public boolean isSharpExpiry()
```
  - setSharpExpiry
```
public void setSharpExpiry(boolean sharpExpiry)
```
    See Also:
    RootAnyBuilder.sharpExpiry(boolean)
  - isSuppressExceptions
```
public boolean isSuppressExceptions()
```
  - setSuppressExceptions
```
public void setSuppressExceptions(boolean suppressExceptions)
```
    See Also:
    CacheBuilder.suppressExceptions(boolean)
  - getHeapEntryCapacity
```
public int getHeapEntryCapacity()
```
  - setHeapEntryCapacity
```
public void setHeapEntryCapacity(int v)
```
    Maximum number of entries that the cache keeps in the heap. Only relevant if a storage modules is defined.
  - getModuleConfiguration
```
public List<Object> getModuleConfiguration()
```
  - setModuleConfiguration
```
public void setModuleConfiguration(List<Object> moduleConfiguration)
```
  - getImplementation
```
public Class<?> getImplementation()
```
  - setImplementation
```
public void setImplementation(Class<?> cacheImplementation)
```
  - getStorageModules
```
public List<StorageConfiguration> getStorageModules()
```

Class CacheConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheConfig

Method Detail

getName

setName

getMaxSize

setMaxSize

getMaxSizeHighBound

setMaxSizeHighBound

getMaxSizeLowBound

setMaxSizeLowBound

isBackgroundRefresh

setBackgroundRefresh

getKeyType

setKeyType

getValueType

getEntryType

setEntryType

setValueType

isEternal

setEternal

setExpirySeconds

getExpirySeconds

getExpiryMillis

setExpiryMillis

getExceptionExpiryMillis

setExceptionExpiryMillis

isKeepDataAfterExpired

setKeepDataAfterExpired

isSharpExpiry

setSharpExpiry

isSuppressExceptions

setSuppressExceptions

getHeapEntryCapacity

setHeapEntryCapacity

getModuleConfiguration

setModuleConfiguration

getImplementation

setImplementation

getStorageModules