com.scaleout.client.caching

Enum CacheEntryDisposition

java.lang.Object

java.lang.Enum<CacheEntryDisposition>

com.scaleout.client.caching.CacheEntryDisposition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CacheEntryDisposition>

public enum CacheEntryDisposition
extends java.lang.Enum<CacheEntryDisposition>

Cache entry disposition is used by the CacheEntryExpirationHandler to tell a Cache what to do with an object that has expired.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NotHandled The client has not handled the event; the object will be removed.
Remove The client would like the object removed from the store.
Save The client would like to keep the object in the store.

Method Summary

Modifier and Type	Method and Description
int	value() retrieve the value of this enum.
static CacheEntryDisposition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CacheEntryDisposition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Save

public static final CacheEntryDisposition Save

The client would like to keep the object in the store.

Remove

public static final CacheEntryDisposition Remove

The client would like the object removed from the store.

NotHandled

public static final CacheEntryDisposition NotHandled

The client has not handled the event; the object will be removed.

Method Detail

values

public static CacheEntryDisposition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CacheEntryDisposition c : CacheEntryDisposition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CacheEntryDisposition valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public int value()

retrieve the value of this enum.

Returns:

the value of this enum.