org.nerd4j.utils.cache

Class CacheEntry<V>

java.lang.Object

org.nerd4j.utils.cache.CacheEntry<V>

Type Parameters:

V - type of data in the cache entry.

All Implemented Interfaces:

Serializable

public class CacheEntry<V>
extends Object
implements Serializable

Represents an entry in the caching system related to a given key.

This entry contains the actual data to be cached and an expiration token.

The expiration token is used internally by the SelfLoadingCache to decide if the entry needs to be updated. This allows to update che cache entry asynchronously while the cache keep serving the stored data.

Since:

2.0.0

Author:

Massimo Coluzzi

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheEntry() Default constructor.
protected	CacheEntry(V value, Instant expiration) Constructor with parameters.
protected	CacheEntry(V value, long expiration) Constructor with parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Instant	getExpiration() Returns the instant in time when the cache entry expires.
V	getValue() Returns the cached value.
int	hashCode()
boolean	isExpired() Tells if the cache entry is expired.
static <V> CacheEntry<V>	of(V value, Instant expiration) Creates a new CacheEntry with the given value and duration.
static <V> CacheEntry<V>	of(V value, long expiration) Creates a new CacheEntry with the given value and duration.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheEntry

protected CacheEntry()

Default constructor.

This constructor is intended to be used by reflection during de-serialization.

To create a new cache entry use the factory methods.

CacheEntry

protected CacheEntry(V value,
                     long expiration)

Constructor with parameters.

This constructor is intended to be used by extending classes only.

To create a new cache entry use the factory methods.

Parameters:

value - value to be cached.

expiration - Unix Timestamp (in milliseconds) that tells when the entry expires.

CacheEntry

protected CacheEntry(V value,
                     Instant expiration)

Constructor with parameters.

This constructor is intended to be used by extending classes only.

To create a new cache entry use the factory methods.

Parameters:

value - value to be cached.

expiration - instant in time when the cache entry expires.

Method Detail

of

public static <V> CacheEntry<V> of(V value,
                                   long expiration)

Creates a new CacheEntry with the given value and duration.

Type Parameters:

V - type of the value to put into cache.

Parameters:

value - the value to put into cache.

expiration - Unix Timestamp (in milliseconds) when the entry expires.

Returns:

a new CacheEntry with the given value and duration.

of

public static <V> CacheEntry<V> of(V value,
                                   Instant expiration)

Creates a new CacheEntry with the given value and duration.

The value can also be null while the expiration instant must be not null

Type Parameters:

V - type of the value to put into cache.

Parameters:

value - the value to put into cache.

expiration - instant in time when the cache entry expires.

Returns:

a new CacheEntry with the given value and duration.

getValue

public V getValue()

Returns the cached value.

Returns:

the cached value.

getExpiration

public Instant getExpiration()

Returns the instant in time when the cache entry expires.

Returns:

the instant in time when the cache entry expires.

isExpired

public boolean isExpired()

Tells if the cache entry is expired.

Returns:

true if the cache entry is expired.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object