ExpiryTimeValues (cache2k API 2.6.1.Final API)

All Known Subinterfaces:

ExpiryPolicy<K,V>, ResiliencePolicy<K,V>

All Known Implementing Classes:

Expiry
```
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), MutableCacheEntry.setExpiryTime(long), Expiry

Field Summary

Fields
Modifier and Type	Field	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`	`NOW`	The value expires immediately and will not be cached.
`static long`	`REFRESH`	Expires the entry and starts a refresh if `Cache2kBuilder.refreshAhead(boolean)` is enabled.

- Field Detail
  - NEUTRAL
```
static final long NEUTRAL
```
    Don't change the expiry of the entry. This can be used for an update. This is also used for an undefined / not applicable expiry time value in MutableCacheEntry.getExpiryTime(). The value is identical to Cache2kConfig.UNSET_LONG
    
    See Also:
    
    Constant Field Values
  - NOW
```
static final long NOW
```
    The value expires immediately and will not be cached. No refreshing is started.
    
    See Also:
    
    Constant Field Values
  - REFRESH
```
static final long REFRESH
```
    Expires the entry and starts a refresh if Cache2kBuilder.refreshAhead(boolean) is enabled. With a positive value the current value is visible until the refresh is complete. With a negative value a get() requests will block until the refreshed value is available.
    Rationale: Any value in the past does and between the current time, does the same as if the time is reached just now.
    
    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