net.java.truelicense.core.util

Class CacheEntry<K,V>

java.lang.Object

java.util.AbstractMap.SimpleEntry<K,V>

net.java.truelicense.core.util.CacheEntry<K,V>

All Implemented Interfaces:

Serializable, Map.Entry<K,V>

@Immutable
public class CacheEntry<K,V>
extends AbstractMap.SimpleEntry<K,V>

A cache entry.

Author:

Christian Schlichtherle

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CacheEntry(K key, V value) Constructs a new cache entry.
CacheEntry(K key, V value, long cachePeriodMillis) Constructs a new cache entry.

Method Summary

Modifier and Type	Method and Description
long	getCachePeriodMillis() Returns the cache period in milliseconds.
long	getStartTimeMillis() Returns the time of cache entry creation.
boolean	isObsolete() Returns true if and only if the cache period has elapsed.
V	map(K key) Maps the given key to the value of this cache entry if it matches or otherwise returns null.
boolean	matches(K key) Returns true if and only if the given key equals the key of this cache entry and this cache entry is not obsolete.

Methods inherited from class java.util.AbstractMap.SimpleEntry

equals, getKey, getValue, hashCode, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

CacheEntry

public CacheEntry(@CheckForNull
                  K key,
                  @CheckForNull
                  V value)

Constructs a new cache entry. The new cache entry will have Long.MAX_VALUE as its timeout.

Parameters:

key - the key.

value - the value.

CacheEntry

public CacheEntry(@CheckForNull
                  K key,
                  @CheckForNull
                  V value,
                  long cachePeriodMillis)

Constructs a new cache entry.

Parameters:

key - the key.

value - the value.

cachePeriodMillis - the cache period of this entry in milliseconds.

Method Detail

getCachePeriodMillis

public long getCachePeriodMillis()

Returns the cache period in milliseconds.

getStartTimeMillis

public long getStartTimeMillis()

Returns the time of cache entry creation.

isObsolete

public boolean isObsolete()

Returns true if and only if the cache period has elapsed.

map

@CheckForNull
public V map(@CheckForNull
                           K key)

Maps the given key to the value of this cache entry if it matches or otherwise returns null.

matches

public boolean matches(@CheckForNull
                       K key)

Returns true if and only if the given key equals the key of this cache entry and this cache entry is not obsolete.

Parameters:

key - the key to test.