com.scaleoutsoftware.soss.client

Enum ReadLockingMode

java.lang.Object

java.lang.Enum<ReadLockingMode>

com.scaleoutsoftware.soss.client.ReadLockingMode

All Implemented Interfaces:

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

public enum ReadLockingMode
extends java.lang.Enum<ReadLockingMode>
implements java.io.Serializable

An enumeration used to control locking behavior during Retrieve and GetMetadata operation

Enum Constant Summary

Enum Constants

Enum Constant and Description
LockOnRead The object should be locked in the StateServer so that the calling thread can establish exclusive access.
NoLockOnRead The object should not be locked in the StateServer.

Method Summary

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

LockOnRead

public static final ReadLockingMode LockOnRead

The object should be locked in the StateServer so that the calling thread can establish exclusive access.

NoLockOnRead

public static final ReadLockingMode NoLockOnRead

The object should not be locked in the StateServer. Note that this option will not release a lock if the caller locked the object earlier--call NamedCache.releaseLock(CachedObjectId) to release an existing lock.

Method Detail

values

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

Returns:

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

valueOf

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