com.pushtechnology.diffusion.client.session

Enum Session.SessionLockScope

java.lang.Object

java.lang.Enum<Session.SessionLockScope>

com.pushtechnology.diffusion.client.session.Session.SessionLockScope

All Implemented Interfaces:

Serializable, Comparable<Session.SessionLockScope>

Enclosing interface:

Session

public static enum Session.SessionLockScope
extends Enum<Session.SessionLockScope>

Values for the scope parameter of Session.lock(String, SessionLockScope).

Since:

6.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNLOCK_ON_CONNECTION_LOSS The lock will be released when the acquiring session loses its current connection to the server.
UNLOCK_ON_SESSION_LOSS The lock will be released when the acquiring session is closed.

Method Summary

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

UNLOCK_ON_CONNECTION_LOSS

public static final Session.SessionLockScope UNLOCK_ON_CONNECTION_LOSS

The lock will be released when the acquiring session loses its current connection to the server.

UNLOCK_ON_SESSION_LOSS

public static final Session.SessionLockScope UNLOCK_ON_SESSION_LOSS

The lock will be released when the acquiring session is closed.

Method Detail

values

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

Returns:

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

valueOf

public static Session.SessionLockScope valueOf(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:

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

NullPointerException - if the argument is null