org.seedstack.jcache

Enum JCacheConfig.ExpiryPolicy

java.lang.Object

java.lang.Enum<JCacheConfig.ExpiryPolicy>

org.seedstack.jcache.JCacheConfig.ExpiryPolicy

All Implemented Interfaces:

Serializable, Comparable<JCacheConfig.ExpiryPolicy>

Enclosing class:

JCacheConfig

public static enum JCacheConfig.ExpiryPolicy
extends Enum<JCacheConfig.ExpiryPolicy>

Enumerates all built-in expiry policies.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESSED An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on the last time it was accessed.
CREATED An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on when it was created.
ETERNAL An eternal ExpiryPolicy specifies that Cache Entries won't expire.
MODIFIED An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on the last time it was updated.
TOUCHED An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on when it was last touched.

Method Summary

Modifier and Type	Method and Description
javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>	getFactory(javax.cache.expiry.Duration duration)
static JCacheConfig.ExpiryPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static JCacheConfig.ExpiryPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOUCHED

public static final JCacheConfig.ExpiryPolicy TOUCHED

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.

ACCESSED

public static final JCacheConfig.ExpiryPolicy ACCESSED

An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on the last time it was accessed. Accessed does not include a cache update.

CREATED

public static final JCacheConfig.ExpiryPolicy CREATED

An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on when it was created. An update does not reset the expiry time.

ETERNAL

public static final JCacheConfig.ExpiryPolicy ETERNAL

An eternal ExpiryPolicy specifies that Cache Entries won't expire. This however doesn't mean they won't be evicted if an underlying implementation needs to free-up resources where by it may choose to evict entries that are not due to expire.

MODIFIED

public static final JCacheConfig.ExpiryPolicy MODIFIED

An ExpiryPolicy that defines the expiry Duration of a Cache Entry based on the last time it was updated. Updating includes created and changing (updating) an entry.

Method Detail

values

public static JCacheConfig.ExpiryPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JCacheConfig.ExpiryPolicy c : JCacheConfig.ExpiryPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JCacheConfig.ExpiryPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFactory

public javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> getFactory(javax.cache.expiry.Duration duration)