JSR107 API and SPI 1.1.1 · javax.cache.expiry.ExpiryPolicy

Method Summary

Modifier and Type	Method and Description
public Duration	Returns: the new `Duration` before an accessed entry expires getExpiryForAccess() Gets the `Duration` before an accessed Cache.Entry is considered expired.
public Duration	Returns: the new `Duration` before a created entry expires getExpiryForCreation() Gets the `Duration` before a newly created Cache.Entry is considered expired.
public Duration	Returns: the new `Duration` before an updated entry expires getExpiryForUpdate() Gets the `Duration` before an updated Cache.Entry is considered expired.

Method Detail

getExpiryForAccess back to summary

getExpiryForAccess	back to summary
public Duration getExpiryForAccess() Gets the `Duration` before an accessed Cache.Entry is considered expired. This method is called by a caching implementation after a Cache.Entry is accessed to determine the `Duration` before an entry expires. If a `Duration#ZERO` is returned a Cache.Entry will be considered immediately 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. Returns:Duration the new `Duration` before an accessed entry expires

public Duration getExpiryForAccess()

Gets the Duration before an accessed Cache.Entry is considered expired.

This method is called by a caching implementation after a Cache.Entry is accessed to determine the Duration before an entry expires. If a Duration#ZERO is returned a Cache.Entry will be considered immediately 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.

Returns:Duration: the new Duration before an accessed entry expires

getExpiryForCreation back to summary

getExpiryForCreation	back to summary
public Duration getExpiryForCreation() Gets the `Duration` before a newly created Cache.Entry is considered expired. This method is called by a caching implementation after a Cache.Entry is created, but before a Cache.Entry is added to a cache, to determine the `Duration` before an entry expires. If a `Duration#ZERO` is returned the new 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. Returns:Duration the new `Duration` before a created entry expires

public Duration getExpiryForCreation()

Gets the Duration before a newly created Cache.Entry is considered expired.

This method is called by a caching implementation after a Cache.Entry is created, but before a Cache.Entry is added to a cache, to determine the Duration before an entry expires. If a Duration#ZERO is returned the new 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.

Returns:Duration: the new Duration before a created entry expires

getExpiryForUpdate back to summary

getExpiryForUpdate	back to summary
public Duration getExpiryForUpdate() Gets the `Duration` before an updated Cache.Entry is considered expired. This method is called by the caching implementation after a Cache.Entry is updated to determine the `Duration` before the updated entry expires. If a `Duration#ZERO` is returned a Cache.Entry is considered immediately 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. Returns:Duration the new `Duration` before an updated entry expires

public Duration getExpiryForUpdate()

Gets the Duration before an updated Cache.Entry is considered expired.

This method is called by the caching implementation after a Cache.Entry is updated to determine the Duration before the updated entry expires. If a Duration#ZERO is returned a Cache.Entry is considered immediately 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.

Returns:Duration: the new Duration before an updated entry expires

public Interface ExpiryPolicy

Method Summary

Method Detail