org.ehcache.core.spi.store

Interface Store.ValueHolder<V>

Type Parameters:

V - the value type

All Superinterfaces:

java.util.function.Supplier<V>

All Known Implementing Classes:

AbstractValueHolder

Enclosing interface:

Store<K,V>

public static interface Store.ValueHolder<V>
extends java.util.function.Supplier<V>

Holds both a value, and all the metadata associated with a mapping in a Store.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_EXPIRE Constant value indicating no expiration - an eternal mapping.

Method Summary

Modifier and Type	Method and Description
long	creationTime() Accessor to the creation time of this ValueHolder
long	expirationTime() Accessor to the expiration time of this ValueHolder
V	get() Returns the value held by this value holder.
long	getId() The combination of this identifier and the key that ValueHolder is mapped to should to be unique at a given time.
boolean	isExpired(long expirationTime) Check if the ValueHolder is expired relative to the specified time
long	lastAccessTime() Accessor to the last access time of the Value held in this ValueHolder

Field Detail

NO_EXPIRE

static final long NO_EXPIRE

Constant value indicating no expiration - an eternal mapping.

See Also:

Constant Field Values

Method Detail

creationTime

long creationTime()

Accessor to the creation time of this ValueHolder

Returns:

the creation time in milliseconds

expirationTime

long expirationTime()

Accessor to the expiration time of this ValueHolder

Returns:

the expiration time in milliseconds. A value of NO_EXPIRE means that the ValueHolder will never expire.

isExpired

boolean isExpired(long expirationTime)

Check if the ValueHolder is expired relative to the specified time

Parameters:

expirationTime - the expiration time (in ms) relative to which the expiry check must be made

Returns:

true if the ValueHolder expired relative to the given expiration time

lastAccessTime

long lastAccessTime()

Accessor to the last access time of the Value held in this ValueHolder

Returns:

the last access time in milliseconds

getId

long getId()

The combination of this identifier and the key that ValueHolder is mapped to should to be unique at a given time.

Returns:

a unique identifier

get

V get()

Returns the value held by this value holder. This value can't be null.

Specified by:

get in interface java.util.function.Supplier<V>

Returns:

the value held