Module io.ebean.api

Package io.ebean

Enum Query.LockType

java.lang.Object

java.lang.Enum<Query.LockType>

io.ebean.Query.LockType

All Implemented Interfaces:

Serializable, Comparable<Query.LockType>

Enclosing interface:

Query<T>

public static enum Query.LockType
extends Enum<Query.LockType>

The lock type (strength) to use with query FOR UPDATE row locking.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	The default lock type being either UPDATE or NO_KEY_UPDATE based on PlatformConfig.forUpdateNoKey configuration (Postgres option).
KEY_SHARE	FOR KEY SHARE (Postgres only).
NO_KEY_UPDATE	FOR NO KEY UPDATE (Postgres only).
SHARE	FOR SHARE (Postgres only).
UPDATE	FOR UPDATE.

Method Summary

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

DEFAULT

public static final Query.LockType DEFAULT

The default lock type being either UPDATE or NO_KEY_UPDATE based on PlatformConfig.forUpdateNoKey configuration (Postgres option).

UPDATE

public static final Query.LockType UPDATE

FOR UPDATE.

NO_KEY_UPDATE

public static final Query.LockType NO_KEY_UPDATE

FOR NO KEY UPDATE (Postgres only).

SHARE

public static final Query.LockType SHARE

FOR SHARE (Postgres only).

KEY_SHARE

public static final Query.LockType KEY_SHARE

FOR KEY SHARE (Postgres only).

Method Detail

values

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

Returns:

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

valueOf

public static Query.LockType 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