org.cache2k.expiry

Interface ExpiryTimeValues

All Known Subinterfaces:

ExpiryPolicy<K,V>

All Known Implementing Classes:

Expiry, ResiliencePolicy

public interface ExpiryTimeValues

Expiry time values that have a special meaning. Used for expressive return values in the customizations ResiliencePolicy and ExpiryPolicy as well as Cache.expireAt(Object, long).

Users may want to use the class Expiry with additional utility methods as alternative.

Author:

Jens Wilke

See Also:

ExpiryPolicy, ResiliencePolicy, Cache.expireAt(K, long), Expiry

Field Summary

Fields

Modifier and Type	Field and Description
static long	ETERNAL Return value signalling to keep the value forever in the cache, switching off expiry.
static long	NEUTRAL Don't change the expiry of the entry.
static long	NO_CACHE Value should not be cached.
static long	NOW Identical to NO_CACHE.
static long	REFRESH An immediate load is triggered if refreshAhead is enabled.

Field Detail

NEUTRAL

static final long NEUTRAL

Don't change the expiry of the entry. This can be used for an update.

See Also:

Constant Field Values

NO_CACHE

static final long NO_CACHE

Value should not be cached. In a read through configuration the value will be reloaded, when it is requested again.

See Also:

Constant Field Values

NOW

static final long NOW

Identical to NO_CACHE. More meaningful when used together with Cache.expireAt(K, long). The value expires immediately. An immediate load is triggered if refreshAhead is enabled.

See Also:

Constant Field Values

REFRESH

static final long REFRESH

An immediate load is triggered if refreshAhead is enabled. If the refresh is not possible, for example because of no loader threads are available the value will expire.

After the load operation is completed, the entry is in a special area and not accessible by direct cache operations, meaning containsKey returns false. After an operation which would regularly trigger a load (e.g. get or loadAll), the entry is present in the cache.

See Also:

Constant Field Values

ETERNAL

static final long ETERNAL

Return value signalling to keep the value forever in the cache, switching off expiry. If the cache has a static expiry time configured, then this is used instead.

See Also:

Constant Field Values