com.scaleout.client.caching

Enum ClientCacheOptions

java.lang.Object

java.lang.Enum<ClientCacheOptions>

com.scaleout.client.caching.ClientCacheOptions

All Implemented Interfaces:

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

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

The ClientCacheOptions enum indicates in-memory client cache usage.

The ClientCacheOptions can be used to disable the in-memory ClientCache or dictate ClientCache behavior.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DeepCopy Returns a "deep copy" of the object.
Disable Disables the client cache.
Reference Returns a reference to the object.

Method Summary

Modifier and Type	Method and Description
static ClientCacheOptions	fromString(java.lang.String value) Retrieve a ClientCacheOptions enum from a string.
static ClientCacheOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClientCacheOptions[]	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

Reference

public static final ClientCacheOptions Reference

Returns a reference to the object. Note, multiple threads accessing the same reference could cause unexpected behavior.

DeepCopy

public static final ClientCacheOptions DeepCopy

Returns a "deep copy" of the object.

Disable

public static final ClientCacheOptions Disable

Disables the client cache.

Method Detail

values

public static ClientCacheOptions[] 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 (ClientCacheOptions c : ClientCacheOptions.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientCacheOptions 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

fromString

public static ClientCacheOptions fromString(java.lang.String value)

Retrieve a ClientCacheOptions enum from a string. Accepted values: Constants.OBJECT_CLIENT_CACHE_OPTION_DEEPCOPY Constants.OBJECT_CLIENT_CACHE_OPTION_REFERENCE Constants.OBJECT_CLIENT_CACHE_OPTION_DISABLED

Parameters:

value - Constants.OBJECT_CLIENT_CACHE_OPTION_DEEPCOPY, Constants.OBJECT_CLIENT_CACHE_OPTION_REFERENCE Constants.OBJECT_CLIENT_CACHE_OPTION_DISABLED

Returns:

a ClientCacheOption that maps from the parameter string value.