dk.heick.caching

Class DefaultLRUCachingMapConfiguration

java.lang.Object

dk.heick.caching.DefaultLRUCachingMapConfiguration

All Implemented Interfaces:

LRUCachingMapConfiguration

public class DefaultLRUCachingMapConfiguration
extends Object
implements LRUCachingMapConfiguration

The default implementation of LRUCachingMapConfiguration.
Made with a builder pattern.

Since:

1.0

Author:

Frederik Heick

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CLEANUP_INTERVAL Default cleanup interval is 15 minuttes.
static long	DEFAULT_EXPIRE_TIME Default expiretime is 10 hours.
static long	DEFAULT_EXTEND_TIME Default extend time is 1 hour.
static int	DEFAULT_MAX_EXTEND_COUNT Default max extend count is 5
static int	DEFAULT_MAX_SIZE Default max size is 10000.
static boolean	DEFAULT_PERSISTED_VALUES_IN_MEMORY Default value if persisted values should be stored in memory as well - true.

Constructor Summary

Constructors

Constructor and Description
DefaultLRUCachingMapConfiguration() Default constructor using default parameters as constructor parameters.
DefaultLRUCachingMapConfiguration(long expireTime, long extendTime, int maxExtendCount, int maxSize, long cleanupInterval, boolean persistedValuesInMemory) Constructor.
DefaultLRUCachingMapConfiguration(TimeSpan expireTime, TimeSpan extendTime, int maxExtendCount, int maxSize, TimeSpan cleanupInterval, boolean persistedValuesInMemory) Constructor.

Method Summary

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.
DefaultLRUCachingMapConfiguration	noAutoCleanup() Sets the cleanupIntervalTime to zero. Meaning during the construction of a LRUCachingMap, no cleanup timer thread is created.
DefaultLRUCachingMapConfiguration	noExtendTime() Sets the extendTime to zero.
DefaultLRUCachingMapConfiguration	noMaxExtendCount() Sets the maxExtendCount to zero.
static DefaultLRUCachingMapConfiguration	ONE_DAY() Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is: expireTime : 1 day extendTime : 1 hour maxExtendCount : 5 maxSize : 10000 cleanupInterval : 15 minutes persistedValuesInMemory : false
static DefaultLRUCachingMapConfiguration	ONE_HOUR() Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is: expireTime : 1 hour extendTime : 5 minutes maxExtendCount : 5 maxSize : 10000 cleanupInterval : 5 minutes persistedValuesInMemory : true
static DefaultLRUCachingMapConfiguration	ONE_MINUTE() Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is: expireTime : 1 minute extendTime : 0 maxExtendCount : 5 maxSize : 1000 cleanupInterval : 1 minute persistedValuesInMemory : true
static DefaultLRUCachingMapConfiguration	ONE_WEEK() Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is: expireTime : 7 days extendTime : 6 hours maxExtendCount : 5 maxSize : 10000 cleanupInterval : 1 hour persistedValuesInMemory : false
DefaultLRUCachingMapConfiguration	setCleanupIntervalTime(long cleanupIntervalTime) Setting this value AFTER the LRUCachingMap has been constructed has NO effect !!!!.
DefaultLRUCachingMapConfiguration	setCleanupIntervalTimeSpan(TimeSpan cleanupIntervalTimeSpan) Sets the cleanupIntervalTime using a TimeSpan.
DefaultLRUCachingMapConfiguration	setExpireTime(long expireTime) Set the expireTime for a key in milliseconds.
DefaultLRUCachingMapConfiguration	setExpireTimeSpan(TimeSpan expireTimeSpan) Sets the expireTime using a TimeSpan.
DefaultLRUCachingMapConfiguration	setExtendTime(long extendTime) How many milliseconds a "key"'s expire time is extended in milliseconds everytime is it "get" from a "LRUCachingMap".
DefaultLRUCachingMapConfiguration	setExtendTimeSpan(TimeSpan extendTimeSpan) Sets the extendTime using a TimeSpan.
DefaultLRUCachingMapConfiguration	setMaxExtendCount(int maxExtendCount) How many times a "key"'s expire time is allowed to be extended.
DefaultLRUCachingMapConfiguration	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.
static DefaultLRUCachingMapConfiguration	TEN_MINUTES() Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is: expireTime : 10 minutes extendTime : 1 minute maxExtendCount : 5 maxSize : 5000 cleanupInterval : 2 minutes persistedValuesInMemory : true

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPIRE_TIME

public static final long DEFAULT_EXPIRE_TIME

Default expiretime is 10 hours.

DEFAULT_EXTEND_TIME

public static final long DEFAULT_EXTEND_TIME

Default extend time is 1 hour.

DEFAULT_MAX_EXTEND_COUNT

public static final int DEFAULT_MAX_EXTEND_COUNT

Default max extend count is 5

See Also:

Constant Field Values

DEFAULT_CLEANUP_INTERVAL

public static final long DEFAULT_CLEANUP_INTERVAL

Default cleanup interval is 15 minuttes.

DEFAULT_MAX_SIZE

public static final int DEFAULT_MAX_SIZE

Default max size is 10000.

See Also:

Constant Field Values

DEFAULT_PERSISTED_VALUES_IN_MEMORY

public static final boolean DEFAULT_PERSISTED_VALUES_IN_MEMORY

Default value if persisted values should be stored in memory as well - true.

See Also:

Constant Field Values

Constructor Detail

DefaultLRUCachingMapConfiguration

public DefaultLRUCachingMapConfiguration()

Default constructor using default parameters as constructor parameters.

See Also:

DEFAULT_EXPIRE_TIME, DEFAULT_EXTEND_TIME, DEFAULT_MAX_EXTEND_COUNT, DEFAULT_MAX_SIZE, DEFAULT_CLEANUP_INTERVAL, DEFAULT_PERSISTED_VALUES_IN_MEMORY

DefaultLRUCachingMapConfiguration

public DefaultLRUCachingMapConfiguration(TimeSpan expireTime,
                                         TimeSpan extendTime,
                                         int maxExtendCount,
                                         int maxSize,
                                         TimeSpan cleanupInterval,
                                         boolean persistedValuesInMemory)

Constructor.
Will only call "getValueWrapperFactory().initialize(this)" is "getValueWrapperFactory().isPersistence()" is "true".

Parameters:

expireTime - How many milliseconds a key may be in the cache per default, before it is removed from cache. Must be be greather the zero.

extendTime - How How many times an Key/Value pair is allowed to be extended in expiretime/TTL. If zero than no extension. If less than zero, not limit to the extension count.

maxExtendCount - How many times a a Keys expire time can be extended when get(K key) is called. If zero or less, than no extension of expire time is performed.

maxSize - 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.

cleanupInterval - How many milliseconds between automatic cleanup of the cache, performed by an internal thread. If zero or less no cleanup thread is created, and you must handle this manually.

persistedValuesInMemory - if persisted values should also be stored in memory for quick access.

Throws:

IllegalArgumentException - if any of the parameters fails validation.

NullPointerException - if any of the timeunit parameters is null.

DefaultLRUCachingMapConfiguration

public DefaultLRUCachingMapConfiguration(long expireTime,
                                         long extendTime,
                                         int maxExtendCount,
                                         int maxSize,
                                         long cleanupInterval,
                                         boolean persistedValuesInMemory)
                                  throws IllegalArgumentException,
                                         NullPointerException

Constructor.
Will only call "getValueWrapperFactory().initialize(this)" is "getValueWrapperFactory().isPersistence()" is "true".

Parameters:

expireTime - How many milliseconds a key may be in the cache per default, before it is removed from cache. Must be be greather the zero.

extendTime - How How many times an Key/Value pair is allowed to be extended in expiretime/TTL. If zero than no extension. If less than zero, not limit to the extension count.

maxExtendCount - How many times a a Keys expire time can be extended when get(K key) is called. If zero or less, than no extension of expire time is performed.

maxSize - 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.

cleanupInterval - how many milliseconds between automatic cleanup of the cache, performed by an internal thread. If zero or less no cleanup thread is created, and you must handle this manually.

persistedValuesInMemory - if persisted values should also be stored in memory for quick access.

Throws:

IllegalArgumentException - if any of the parameters fails validation.

NullPointerException

Method Detail

ONE_WEEK

public static final DefaultLRUCachingMapConfiguration ONE_WEEK()

Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is:

• expireTime : 7 days
• extendTime : 6 hours
• maxExtendCount : 5
• maxSize : 10000
• cleanupInterval : 1 hour
• persistedValuesInMemory : false

Returns:

a DefaultLRUCachingMapConfiguration instance.

ONE_DAY

public static final DefaultLRUCachingMapConfiguration ONE_DAY()

Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is:

• expireTime : 1 day
• extendTime : 1 hour
• maxExtendCount : 5
• maxSize : 10000
• cleanupInterval : 15 minutes
• persistedValuesInMemory : false

Returns:

a DefaultLRUCachingMapConfiguration instance.

ONE_HOUR

public static final DefaultLRUCachingMapConfiguration ONE_HOUR()

Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is:

• expireTime : 1 hour
• extendTime : 5 minutes
• maxExtendCount : 5
• maxSize : 10000
• cleanupInterval : 5 minutes
• persistedValuesInMemory : true

Returns:

a DefaultLRUCachingMapConfiguration instance.

TEN_MINUTES

public static final DefaultLRUCachingMapConfiguration TEN_MINUTES()

Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is:

• expireTime : 10 minutes
• extendTime : 1 minute
• maxExtendCount : 5
• maxSize : 5000
• cleanupInterval : 2 minutes
• persistedValuesInMemory : true

Returns:

a DefaultLRUCachingMapConfiguration instance.

ONE_MINUTE

public static final DefaultLRUCachingMapConfiguration ONE_MINUTE()

Creates a new instance of DefaultLRUCachingMapConfiguration where the parameters is:

• expireTime : 1 minute
• extendTime : 0
• maxExtendCount : 5
• maxSize : 1000
• cleanupInterval : 1 minute
• persistedValuesInMemory : true

Returns:

a DefaultLRUCachingMapConfiguration instance.

getCleanupIntervalTime

public long getCleanupIntervalTime()

Description copied from interface: LRUCachingMapConfiguration

How long interval between cleanup is performed by an internal thread.

Specified by:

getCleanupIntervalTime in interface LRUCachingMapConfiguration

Returns:

the interval in milliseconds, if value is zero or less, no automatic clanup is performed, and you must handle this your self.

getExpireTime

public long getExpireTime()

Description copied from interface: LRUCachingMapConfiguration

How many milliseconds a key may be in the cache per default, before it is removed from cache.
Must be be greather the zero.

Specified by:

getExpireTime in interface LRUCachingMapConfiguration

Returns:

default caching time.

getExtendTime

public long getExtendTime()

Description copied from interface: LRUCachingMapConfiguration

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.

Specified by:

getExtendTime in interface LRUCachingMapConfiguration

Returns:

the extend time in milliseconds for when a key is "get".

getMaxExtendCount

public int getMaxExtendCount()

Description copied from interface: LRUCachingMapConfiguration

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.

Specified by:

getMaxExtendCount in interface LRUCachingMapConfiguration

Returns:

the maximum time a key must be extended when it is "get".

getMaxSize

public int getMaxSize()

Description copied from interface: LRUCachingMapConfiguration

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.

Specified by:

getMaxSize in interface LRUCachingMapConfiguration

Returns:

the maximum number of key entries in cache.

setCleanupIntervalTime

public DefaultLRUCachingMapConfiguration setCleanupIntervalTime(long cleanupIntervalTime)

Setting this value AFTER the LRUCachingMap has been constructed has NO effect !!!!. Set the cleanup interval in milliseconds.

Specified by:

setCleanupIntervalTime in interface LRUCachingMapConfiguration

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

public DefaultLRUCachingMapConfiguration setExpireTime(long expireTime)
                                                throws IllegalArgumentException

Description copied from interface: LRUCachingMapConfiguration

Set the expireTime for a key in milliseconds.

Specified by:

setExpireTime in interface LRUCachingMapConfiguration

Parameters:

expireTime - the expire time in milliseconds.

Returns:

the LRUCachingMapConfiguration instance.

Throws:

IllegalArgumentException - if expireTime is less than one.

setExtendTime

public DefaultLRUCachingMapConfiguration setExtendTime(long extendTime)

Description copied from interface: LRUCachingMapConfiguration

How many milliseconds a "key"'s expire time is extended in milliseconds everytime is it "get" from a "LRUCachingMap".

Specified by:

setExtendTime in interface LRUCachingMapConfiguration

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

public DefaultLRUCachingMapConfiguration setMaxExtendCount(int maxExtendCount)

Description copied from interface: LRUCachingMapConfiguration

How many times a "key"'s expire time is allowed to be extended.

Specified by:

setMaxExtendCount in interface LRUCachingMapConfiguration

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

public DefaultLRUCachingMapConfiguration setMaxSize(int maxSize)

Description copied from interface: LRUCachingMapConfiguration

The maximum number of elements in a LRUCachingMap before "cleanup" is performed to reduce the map size.

Specified by:

setMaxSize in interface LRUCachingMapConfiguration

Parameters:

maxSize - the maximum number of keys allowed in the cache.

Returns:

the LRUCachingMapConfiguration instance.

See Also:

LRUCachingMap.cleanup(), LRUCachingMap.getNextToExpire()

isPersistedValuesInMemory

public boolean isPersistedValuesInMemory()

Description copied from interface: LRUCachingMapConfiguration

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.

Specified by:

isPersistedValuesInMemory in interface LRUCachingMapConfiguration

Returns:

if values for persisted storage is held in memory or not.

setPersistedValuesInMemory

public LRUCachingMapConfiguration setPersistedValuesInMemory(boolean persistedValuesInMemory)

Description copied from interface: LRUCachingMapConfiguration

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.

Specified by:

setPersistedValuesInMemory in interface LRUCachingMapConfiguration

Parameters:

persistedValuesInMemory - is persisted values held in memory.

Returns:

the LRUCachingMapConfiguration instance.

noExtendTime

public DefaultLRUCachingMapConfiguration noExtendTime()

Sets the extendTime to zero.

Returns:

the DefaultLRUCachingMapConfiguration instance.

noMaxExtendCount

public DefaultLRUCachingMapConfiguration noMaxExtendCount()

Sets the maxExtendCount to zero.

Returns:

the DefaultLRUCachingMapConfiguration instance.

noAutoCleanup

public DefaultLRUCachingMapConfiguration noAutoCleanup()

Sets the cleanupIntervalTime to zero.
Meaning during the construction of a LRUCachingMap, no cleanup timer thread is created.

Returns:

the DefaultLRUCachingMapConfiguration instance.

See Also:

CleanupTimerRunnable

setExtendTimeSpan

public final DefaultLRUCachingMapConfiguration setExtendTimeSpan(TimeSpan extendTimeSpan)
                                                          throws NullPointerException

Sets the extendTime using a TimeSpan.

Parameters:

extendTimeSpan - the timespan for extendTime.

Returns:

the DefaultLRUCachingMapConfiguration instance.

Throws:

NullPointerException - if the extendTimeSpan is null.

setCleanupIntervalTimeSpan

public final DefaultLRUCachingMapConfiguration setCleanupIntervalTimeSpan(TimeSpan cleanupIntervalTimeSpan)
                                                                   throws NullPointerException

Sets the cleanupIntervalTime using a TimeSpan.
Setting this value AFTER the LRUCachingMap has been constructed has NO effect !!!!.

Parameters:

cleanupIntervalTimeSpan - the timespan for cleanupIntervalTime.

Returns:

the DefaultLRUCachingMapConfiguration instance.

Throws:

NullPointerException - if the cleanupIntervalTimeSpan is null.

setExpireTimeSpan

public final DefaultLRUCachingMapConfiguration setExpireTimeSpan(TimeSpan expireTimeSpan)
                                                          throws IllegalArgumentException,
                                                                 NullPointerException

Sets the expireTime using a TimeSpan.

Parameters:

expireTimeSpan - the timespan for expireTime.

Returns:

the DefaultLRUCachingMapConfiguration instance.

Throws:

IllegalArgumentException

NullPointerException - if the expireTimeSpan is null.