Package org.hibernate.annotations

Enum Class OptimisticLockType

java.lang.Object

java.lang.Enum<OptimisticLockType>

org.hibernate.annotations.OptimisticLockType

All Implemented Interfaces:

Serializable, Comparable<OptimisticLockType>, Constable

public enum OptimisticLockType
extends Enum<OptimisticLockType>

Enumerates the possible optimistic lock checking strategies.

See Also:

• OptimisticLocking

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Optimistic locking based on all fields of the entity.
DIRTY	Optimistic locking based on dirty fields of the entity.
NONE	No optimistic locking.
VERSION	Optimistic locking using a dedicated timestamp column or version column.

Method Summary

Modifier and Type	Method	Description
static OptimisticLockType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OptimisticLockType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final OptimisticLockType NONE

No optimistic locking.

VERSION

public static final OptimisticLockType VERSION

Optimistic locking using a dedicated timestamp column or version column. This is the usual strategy.

Any SQL update or delete statement will have a where clause restriction which specifies the primary key and current version. If no rows are updated, this is interpreted as a lock checking failure.

See Also:

• Version

DIRTY

public static final OptimisticLockType DIRTY

Optimistic locking based on dirty fields of the entity.

A SQL update or delete statement will have every dirty field of the entity instance listed in the where clause restriction.

ALL

public static final OptimisticLockType ALL

Optimistic locking based on all fields of the entity.

A SQL update or delete statement will have every field of the entity listed in the where clause restriction.

Method Details

values

public static OptimisticLockType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OptimisticLockType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null