wirelabs.commons

Class ExpirableCache<T>

java.lang.Object

wirelabs.commons.ExpirableCache<T>

Type Parameters:

T - the type of stored values

All Implemented Interfaces:

Serializable

public class ExpirableCache<T>
extends Object
implements Serializable

A cache for expirable entries. The cache is basically a map of entries indexed by strings.

Author:

takeuchi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExpirableCache(long ttl)

Method Summary

Modifier and Type	Method and Description
T	get(String key, ExpirableCacheRepopulator<T> populate) Retrieves a value from the cache.
T	get(String key, long ttl, ExpirableCacheRepopulator<T> populate) Retrieves a value from the cache
T	put(String key, T value) Puts a value in the cache.
T	put(String key, T value, long ttl) Puts a value in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpirableCache

public ExpirableCache(long ttl)

Parameters:

ttl - The default "Time to live" (ttl) for the entries

Method Detail

put

public T put(String key,
             T value)

Puts a value in the cache. The value will expire after the default ttl

Parameters:

key - the entry key

value - the entry value

Returns:

the stored entry

put

public T put(String key,
             T value,
             long ttl)

Puts a value in the cache.

Parameters:

key - the entry key

value - the entry value

ttl - a custom time to live for this entry

Returns:

the stored entry

get

public T get(String key,
             ExpirableCacheRepopulator<T> populate)

Retrieves a value from the cache. Uses the default ttl

Parameters:

key - the key to retrieve

populate - the function to re-populate if the value is expired or non existent

Returns:

get

public T get(String key,
             long ttl,
             ExpirableCacheRepopulator<T> populate)

Retrieves a value from the cache

Parameters:

key - the key to retrieve

ttl - the time to live in case the value is repopulated

populate - the function to re-populate if the value is expired or non existent

Returns:

the value for the key or the value produced by the populate function