LRUCachingMapConfiguration (JHCaching 0.8 API)

All Known Implementing Classes:

DefaultLRUCachingMapConfiguration
```
public interface LRUCachingMapConfiguration
```
Interface for LRUCachingMapConfiguration

Since:

1.0

Author:

Frederik Heick

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getCleanupIntervalTime()` How long interval between cleanup is performed by an internal thread.
`long`	`getExpireTime()` How many milliseconds a key may be in the cache per default, before it is removed from cache.
`long`	`getExtendTime()` When a Key is retrieved from the class via get(K key) the Key/Value pair can has it expire time extended.
`int`	`getMaxExtendCount()` How many times an Key/Value pair is allowed to be extended in expiretime.
`int`	`getMaxSize()` How many keys is maximum allowed in the class, if exceeded the oldest entries is removed until below maxSize.
`boolean`	`isPersistedValuesInMemory()` If the values for persisted LRUCachingMaps should be held in memory or not. If `false` the values for persisted storage will have to retrieved from persisted storage for each get, if `true` all values is held in memory as well, this will have an effect on your memory usage.
`LRUCachingMapConfiguration`	`setCleanupIntervalTime(long cleanupIntervalTime)` Set the cleanup interval in milliseconds.
`LRUCachingMapConfiguration`	`setExpireTime(long expireTime)` Set the expireTime for a key in milliseconds.
`LRUCachingMapConfiguration`	`setExtendTime(long extendTime)` How many milliseconds a "key"'s expire time is extended in milliseconds everytime is it "get" from a "LRUCachingMap".
`LRUCachingMapConfiguration`	`setMaxExtendCount(int maxExtendCount)` How many times a "key"'s expire time is allowed to be extended.
`LRUCachingMapConfiguration`	`setMaxSize(int maxSize)` The maximum number of elements in a LRUCachingMap before "cleanup" is performed to reduce the map size.
`LRUCachingMapConfiguration`	`setPersistedValuesInMemory(boolean persistedValuesInMemory)` If the values for persisted LRUCachingMaps should be held in memory or not. If `false` the values for persisted storage will have to retrieved from persisted storage for each get, if `true` all values is held in memory as well, this will have an effect on your memory usage.

- Method Detail
  - getCleanupIntervalTime
```
long getCleanupIntervalTime()
```
    How long interval between cleanup is performed by an internal thread.
    
    Returns:
    
    the interval in milliseconds, if value is zero or less, no automatic clanup is performed, and you must handle this your self.
  - getExpireTime
```
long getExpireTime()
```
    How many milliseconds a key may be in the cache per default, before it is removed from cache.
    Must be be greather the zero.
    
    Returns:
    
    default caching time.
  - getExtendTime
```
long getExtendTime()
```
    When a Key is retrieved from the class via get(K key) the Key/Value pair can has it expire time extended.
    If zero or less, than no extension of expire time is performed.
    
    Returns:
    
    the extend time in milliseconds for when a key is "get".
  - getMaxExtendCount
```
int getMaxExtendCount()
```
    How many times an Key/Value pair is allowed to be extended in expiretime.
    If zero than no extension. If less than zero, not limit to the extension count.
    
    Returns:
    
    the maximum time a key must be extended when it is "get".
  - getMaxSize
```
int getMaxSize()
```
    How many keys is maximum allowed in the class, if exceeded the oldest entries is removed until below maxSize.
    Must be be greather the zero.
    
    Returns:
    
    the maximum number of key entries in cache.
  - setCleanupIntervalTime
```
LRUCachingMapConfiguration setCleanupIntervalTime(long cleanupIntervalTime)
```
    Set the cleanup interval in milliseconds.
    
    Parameters:
    
    cleanupIntervalTime - the cleanup interval in milliseconds, if ">0" an internal timer thread will handle this, otherwise you must handle this yourself.
    
    Returns:
    
    how often in "milliseconds" LRUCachingMap.cleanup() is called.
    
    See Also:
    
    CleanupTimerRunnable
  - setExpireTime
```
LRUCachingMapConfiguration setExpireTime(long expireTime)
                                  throws IllegalArgumentException
```
    Set the expireTime for a key in milliseconds.
    
    Parameters:
    
    expireTime - the expire time in milliseconds.
    
    Returns:
    
    the LRUCachingMapConfiguration instance.
    
    Throws:
    
    IllegalArgumentException - if expireTime is less than one.
  - setExtendTime
```
LRUCachingMapConfiguration setExtendTime(long extendTime)
```
    How many milliseconds a "key"'s expire time is extended in milliseconds everytime is it "get" from a "LRUCachingMap".
    
    Parameters:
    
    extendTime - how many milliseconds a key's expire time is extended in milliseconds everytime is it "get" from a "LRUCachingMap".
    
    Returns:
    
    the LRUCachingMapConfiguration instance.
    
    See Also:
    
    LRUCachingMap.get(Object)
  - setMaxExtendCount
```
LRUCachingMapConfiguration setMaxExtendCount(int maxExtendCount)
```
    How many times a "key"'s expire time is allowed to be extended.
    
    Parameters:
    
    maxExtendCount - How many times a "key"'s expire time is allowed to be extended, if "<=0" than no expiration time extension is allowed.
    
    Returns:
    
    the LRUCachingMapConfiguration instance.
  - setMaxSize
```
LRUCachingMapConfiguration setMaxSize(int maxSize)
```
    The maximum number of elements in a LRUCachingMap before "cleanup" is performed to reduce the map size.
    
    Parameters:
    
    maxSize - the maximum number of keys allowed in the cache.
    
    Returns:
    
    the LRUCachingMapConfiguration instance.
    
    See Also:
    
    LRUCachingMap.cleanup(), LRUCachingMap.getNextToExpire()
  - isPersistedValuesInMemory
```
boolean isPersistedValuesInMemory()
```
    If the values for persisted LRUCachingMaps should be held in memory or not.
    If false the values for persisted storage will have to retrieved from persisted storage for each get, if true all values is held in memory as well, this will have an effect on your memory usage. Only applies for LRUCachingMap implementation which has persisted storage.
    
    Returns:
    
    if values for persisted storage is held in memory or not.
  - setPersistedValuesInMemory
```
LRUCachingMapConfiguration setPersistedValuesInMemory(boolean persistedValuesInMemory)
```
    If the values for persisted LRUCachingMaps should be held in memory or not.
    If false the values for persisted storage will have to retrieved from persisted storage for each get, if true all values is held in memory as well, this will have an effect on your memory usage. Only applies for LRUCachingMap implementation which has persisted storage.
    
    Parameters:
    
    persistedValuesInMemory - is persisted values held in memory.
    
    Returns:
    
    the LRUCachingMapConfiguration instance.

Interface LRUCachingMapConfiguration

Method Summary

Method Detail

getCleanupIntervalTime

getExpireTime

getExtendTime

getMaxExtendCount

getMaxSize

setCleanupIntervalTime

setExpireTime

setExtendTime

setMaxExtendCount

setMaxSize

isPersistedValuesInMemory

setPersistedValuesInMemory