org.cache2k.expiry

Interface ValueWithExpiryTime

public interface ValueWithExpiryTime

Interface to add to a value object if it is possible to derive the expiry time from the value. If no explicit expiry calculator is set and this interface is detected on the value, the expiry requested from the value by the cache.

Important caveat: This interface must be present on the configured cache value type to enable the functionality.

Author:

Jens Wilke

Method Summary

Modifier and Type	Method and Description
long	getCacheExpiryTime() Point in time in milliseconds since when the value should expire.

Method Detail

getCacheExpiryTime

long getCacheExpiryTime()

Point in time in milliseconds since when the value should expire.

Returns:

time the time of expiry in millis since epoch. ExpiryTimeValues.NO_CACHE if it should not cached. ExpiryTimeValues.ETERNAL if there is no specific expiry time known or needed. The effective expiry duration will never be longer than the configured expiry value via Cache2kBuilder.expireAfterWrite(long, TimeUnit) (long, TimeUnit)}. If a negative value is returned, the negated value will be the expiry time used, but sharp expiry is requested always, ignoring Cache2kBuilder.sharpExpiry(boolean).