com.scaleoutsoftware.soss.client

Enum UpdateLockingMode

java.lang.Object

java.lang.Enum<UpdateLockingMode>

com.scaleoutsoftware.soss.client.UpdateLockingMode

All Implemented Interfaces:

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

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

Enumeration used to control locking behavior during update operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
None Indicates that the StateServer should not release an existing pessimistic lock if one is currently being held.
UnlockAfterUpdate If the StateServer is holding a pessimistic lock for the corresponding object then the lock will be released when the Update operation completes.
UpdateIfSameVersion (Optimistic locking.) Indicates that the StateServer should only perform an update if the version version of the object sent by the object matches the version currently stored in the StateServer.

Method Summary

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

Indicates that the StateServer should not release an existing pessimistic lock if one is currently being held. Also indicates that the StateServer should perform the update regardless of the version of the object that is sent to the server (that is, this mode indicates that optimistic locking should not be used).

UnlockAfterUpdate

public static final UpdateLockingMode UnlockAfterUpdate

If the StateServer is holding a pessimistic lock for the corresponding object then the lock will be released when the Update operation completes. If the StateServer is not holding a pessimistic lock for the object then this option will be ignored.

UpdateIfSameVersion

public static final UpdateLockingMode UpdateIfSameVersion

(Optimistic locking.) Indicates that the StateServer should only perform an update if the version version of the object sent by the object matches the version currently stored in the StateServer. Objects that use optimistic locking must implement the OptimisticConcurrencyVersionHolder interface.

Method Detail

values

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

Returns:

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

valueOf

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