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

Modifier and Type	Field and Description
private Duration	expiryDuration The `Duration` a Cache Entry should be available before it expires.
public static final long	serialVersionUID The serialVersionUID required for `java.io.Serializable`.

Access	Constructor and Description
public	CreatedExpiryPolicy(Duration the `Duration` a Cache Entry should exist be before it expires after being modified expiryDuration) Constructs an `CreatedExpiryPolicy` `ExpiryPolicy`.

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static Factory<ExpiryPolicy>	Returns: a `Factory` for a Created `ExpiryPolicy`. factoryOf(Duration The expiry duration duration) Obtains a `Factory` for a Created `ExpiryPolicy`.
public Duration	getExpiryForAccess() Implements javax.cache.expiry.ExpiryPolicy.getExpiryForAccess. Gets the `Duration` before an accessed Cache.Entry is considered expired.
public Duration	getExpiryForCreation() Implements javax.cache.expiry.ExpiryPolicy.getExpiryForCreation. Gets the `Duration` before a newly created Cache.Entry is considered expired.
public Duration	getExpiryForUpdate() Implements javax.cache.expiry.ExpiryPolicy.getExpiryForUpdate. Gets the `Duration` before an updated Cache.Entry is considered expired.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

expiryDuration	back to summary
private Duration expiryDuration The `Duration` a Cache Entry should be available before it expires.

serialVersionUID	back to summary
public static final long serialVersionUID The serialVersionUID required for `java.io.Serializable`.

CreatedExpiryPolicy	back to summary
public CreatedExpiryPolicy(Duration expiryDuration) Constructs an `CreatedExpiryPolicy` `ExpiryPolicy`. Parameters expiryDuration:Duration the `Duration` a Cache Entry should exist be before it expires after being modified

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters object:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

object:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

factoryOf back to summary

factoryOf	back to summary
public static Factory<ExpiryPolicy> factoryOf(Duration duration) Obtains a `Factory` for a Created `ExpiryPolicy`. Parameters duration:Duration The expiry duration Returns:Factory<ExpiryPolicy> a `Factory` for a Created `ExpiryPolicy`.

public static Factory<ExpiryPolicy> factoryOf(Duration duration)

Obtains a Factory for a Created ExpiryPolicy.

Parameters

duration:Duration: The expiry duration

Returns:Factory<ExpiryPolicy>

a Factory for a Created ExpiryPolicy.

getExpiryForAccess back to summary

getExpiryForAccess	back to summary
public Duration getExpiryForAccess() Implements javax.cache.expiry.ExpiryPolicy.getExpiryForAccess. Doc from javax.cache.expiry.ExpiryPolicy.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 Annotations @Override

public Duration getExpiryForAccess()

Implements javax.cache.expiry.ExpiryPolicy.getExpiryForAccess.

Doc from javax.cache.expiry.ExpiryPolicy.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

Annotations

@Override

getExpiryForCreation back to summary

getExpiryForCreation	back to summary
public Duration getExpiryForCreation() Implements javax.cache.expiry.ExpiryPolicy.getExpiryForCreation. Doc from javax.cache.expiry.ExpiryPolicy.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 Annotations @Override

public Duration getExpiryForCreation()

Implements javax.cache.expiry.ExpiryPolicy.getExpiryForCreation.

Doc from javax.cache.expiry.ExpiryPolicy.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

Annotations

@Override

getExpiryForUpdate back to summary

getExpiryForUpdate	back to summary
public Duration getExpiryForUpdate() Implements javax.cache.expiry.ExpiryPolicy.getExpiryForUpdate. Doc from javax.cache.expiry.ExpiryPolicy.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 Annotations @Override

public Duration getExpiryForUpdate()

Implements javax.cache.expiry.ExpiryPolicy.getExpiryForUpdate.

Doc from javax.cache.expiry.ExpiryPolicy.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

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

public final Class CreatedExpiryPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail