com.scaleout.client.caching

Enum BackingStoreMode

java.lang.Object

java.lang.Enum<BackingStoreMode>

com.scaleout.client.caching.BackingStoreMode

All Implemented Interfaces:

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

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

The BackingStoreMode indicates the type of asynchronous backing-store behavior that the server should invoke for an object.

Enum Constant Summary

Enum Constants

Enum Constant and Description
None The server should not perform asynchronous backing store operations for this object.
RefreshAhead The server should periodically notify client code that the object needs to be refreshed in the cache.
WriteBehind The server should periodically notify client code that the cached object needs to be written to a persistent backing store.

Method Summary

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

None

public static final BackingStoreMode None

The server should not perform asynchronous backing store operations for this object.

RefreshAhead

public static final BackingStoreMode RefreshAhead

The server should periodically notify client code that the object needs to be refreshed in the cache.

WriteBehind

public static final BackingStoreMode WriteBehind

The server should periodically notify client code that the cached object needs to be written to a persistent backing store.

Method Detail

values

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

Returns:

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

valueOf

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

get

public byte get()

Returns the byte value for this enum.

Returns:

the byte value for this enum.

fromString

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

Retrieve a backing store mode from a string value. Accepted values: Constants.OBJECT_BACKING_STORE_MODE_NONE Constants.OBJECT_BACKING_STORE_MODE_REFRESHAHEAD Constants.OBJECT_BACKING_STORE_MODE_WRITEBEHIND

Parameters:

value - Constants.OBJECT_BACKING_STORE_MODE_NONE, Constants.OBJECT_BACKING_STORE_MODE_REFRESHAHEAD, or Constants.OBJECT_BACKING_STORE_MODE_WRITEBEHIND

Returns:

a backing store mode.