public class ExpirationAttributes extends java.lang.Object implements DataSerializable
timeToLive and idleTimeout. If the expiration
action is not specified, it defaults to ExpirationAction.INVALIDATE.
If the timeout is not specified, it defaults to zero (which means to never timeout).AttributesFactory,
RegionAttributes,
AttributesMutator,
Serialized FormDataSerializable.Replaceable| Modifier and Type | Field and Description |
|---|---|
static ExpirationAttributes |
DEFAULT
convenience constant for a default instance
|
| Constructor and Description |
|---|
ExpirationAttributes()
Constructs a default
ExpirationAttributes, which indicates no expiration
will take place. |
ExpirationAttributes(int expirationTime)
Constructs an
ExpirationAttributes with the specified expiration time
and the default expiration action ExpirationAction.INVALIDATE. |
ExpirationAttributes(int expirationTime,
ExpirationAction expirationAction)
Constructs an
ExpirationAttributes with the specified expiration time and
expiration action. |
| Modifier and Type | Method and Description |
|---|---|
static ExpirationAttributes |
createFromData(java.io.DataInput in) |
boolean |
equals(java.lang.Object obj) |
void |
fromData(java.io.DataInput in)
Reads the state of this object as primitive data from the given
DataInput. |
ExpirationAction |
getAction()
Returns the action that should take place when this value or region expires.
|
int |
getTimeout()
Returns the number of seconds before a region or value expires.
|
int |
hashCode() |
void |
toData(java.io.DataOutput out)
Writes the state of this object as primitive data to the given
DataOutput. |
java.lang.String |
toString()
Returns a string representation of this
ExpirationAttributes. |
public static final ExpirationAttributes DEFAULT
public ExpirationAttributes()
ExpirationAttributes, which indicates no expiration
will take place.public ExpirationAttributes(int expirationTime)
ExpirationAttributes with the specified expiration time
and the default expiration action ExpirationAction.INVALIDATE.expirationTime - The number of seconds before expirationjava.lang.IllegalArgumentException - if expirationTime is nonpositivepublic ExpirationAttributes(int expirationTime,
ExpirationAction expirationAction)
ExpirationAttributes with the specified expiration time and
expiration action.expirationTime - The number of seconds for a value to live before it expiresexpirationAction - the action to take when the value expiresjava.lang.IllegalArgumentException - if expirationTime is nonpositivepublic int getTimeout()
public ExpirationAction getAction()
public boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic java.lang.String toString()
ExpirationAttributes. If the timeout
is zero, returns "NO EXPIRATION".toString in class java.lang.Objectpublic static ExpirationAttributes createFromData(java.io.DataInput in) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOExceptionjava.lang.ClassNotFoundExceptionpublic void fromData(java.io.DataInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
DataSerializableDataInput.fromData in interface DataSerializablejava.io.IOException - A problem occurs while reading from injava.lang.ClassNotFoundException - A class could not be loaded while reading from
inpublic void toData(java.io.DataOutput out)
throws java.io.IOException
DataSerializableDataOutput.
Since 5.7 it is possible for any method call to the specified
DataOutput to throw GemFireRethrowable.
It should not be caught by user code.
If it is it must be rethrown.
toData in interface DataSerializablejava.io.IOException - A problem occurs while writing to out