javax.cache.expiry

Class TouchedExpiryPolicy<K,V>

java.lang.Object

javax.cache.expiry.TouchedExpiryPolicy<K,V>

Type Parameters:

K - the type of cache keys

V - the type of cache values

All Implemented Interfaces:

Serializable, ExpiryPolicy<K,V>

public final class TouchedExpiryPolicy<K,V>
extends Object
implements ExpiryPolicy<K,V>, Serializable

An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on when it was last touched. A touch includes creation, update or access.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID The serialVersionUID required for Serializable.

Constructor Summary

Constructors

Constructor and Description
TouchedExpiryPolicy(Duration expiryDuration) Constructs an TouchedExpiryPolicy ExpiryPolicy.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static <K,V> Factory<ExpiryPolicy<? super K,? super V>>	factoryOf(Duration duration) Obtains a Factory for a Touched ExpiryPolicy.
Duration	getExpiryForAccessedEntry(Cache.Entry<? extends K,? extends V> entry) Gets the duration before the accessed Cache.Entry is considered expired.
Duration	getExpiryForCreatedEntry(Cache.Entry<? extends K,? extends V> entry) Gets the duration before the newly Cache.Entry is considered expired.
Duration	getExpiryForModifiedEntry(Cache.Entry<? extends K,? extends V> entry) Gets the duration before the modified Cache.Entry is considered expired.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

The serialVersionUID required for Serializable.

See Also:

Constant Field Values

Constructor Detail

TouchedExpiryPolicy

public TouchedExpiryPolicy(Duration expiryDuration)

Constructs an TouchedExpiryPolicy ExpiryPolicy.

Parameters:

expiryDuration - the Duration a Cache Entry should exist be before it expires after being modified

Method Detail

factoryOf

public static <K,V> Factory<ExpiryPolicy<? super K,? super V>> factoryOf(Duration duration)

Obtains a Factory for a Touched ExpiryPolicy.

Returns:

a Factory for a Touched ExpiryPolicy.

getExpiryForCreatedEntry

public Duration getExpiryForCreatedEntry(Cache.Entry<? extends K,? extends V> entry)

Gets the duration before the newly Cache.Entry is considered expired.

This method is called by the caching implementation after a Cache.Entry is created, but before the said entry is added to a cache, to determine the Duration before the said entry expires. If a Duration.ZERO is returned the Cache.Entry is considered to be already expired and will not be added to the Cache.

Should an exception occur while determining the Duration, an implementation specific default Duration will be used.

Specified by:

getExpiryForCreatedEntry in interface ExpiryPolicy<K,V>

Parameters:

entry - the cache entry that was created

Returns:

the new duration until the entry expires

getExpiryForAccessedEntry

public Duration getExpiryForAccessedEntry(Cache.Entry<? extends K,? extends V> entry)

Gets the duration before the accessed Cache.Entry is considered expired.

This method is called by the caching implementation after a Cache.Entry is accessed to determine the Duration before the said entry expires in the future. If a Duration.ZERO is returned the Cache.Entry will be considered expired for future access. Returning null will result in no change to the previously understood expiry Duration.

Should an exception occur while determining the Duration, an implementation specific default Duration will be used.

Specified by:

getExpiryForAccessedEntry in interface ExpiryPolicy<K,V>

Parameters:

entry - the cache entry that was accessed

Returns:

the new duration until the entry expires

getExpiryForModifiedEntry

public Duration getExpiryForModifiedEntry(Cache.Entry<? extends K,? extends V> entry)

Gets the duration before the modified Cache.Entry is considered expired.

This method is called by the caching implementation after a Cache.Entry is modified to determine the Duration before the updated entry expires. If a Duration.ZERO is returned the Cache.Entry is considered already expired. Returning null will result in no change to the previously understood expiry Duration.

Should an exception occur while determining the Duration, an implementation specific default Duration will be used.

Specified by:

getExpiryForModifiedEntry in interface ExpiryPolicy<K,V>

Parameters:

entry - the cache entry that was modified

Returns:

the new duration until the entry expires

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object