Package org.hibernate.engine

Enum OptimisticLockStyle

java.lang.Object

java.lang.Enum<OptimisticLockStyle>

org.hibernate.engine.OptimisticLockStyle

All Implemented Interfaces:

Serializable, Comparable<OptimisticLockStyle>

public enum OptimisticLockStyle
extends Enum<OptimisticLockStyle>

Describes how an entity should be optimistically locked.

API Note:

This enumeration is mainly for internal use, since it is isomorphic to OptimisticLockType. In the future, it would be nice to replace them both with a new org.hibernate.OptimisticLockCheck enum.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Optimistic locking via comparison of all columns.
DIRTY	Optimistic locking via comparison of dirty columns.
NONE	No optimistic locking.
VERSION	Optimistic locking via a dedicated version or timestamp column.

Method Summary

Modifier and Type	Method	Description
static OptimisticLockStyle	fromLockType(OptimisticLockType type)
int	getOldCode()	Deprecated, for removal: This API element is subject to removal in a future version. these integer codes have not been used for a long time
static OptimisticLockStyle	interpretOldCode(int oldCode)	Deprecated, for removal: This API element is subject to removal in a future version. these integer codes have not been used for a long time
boolean	isAll()
boolean	isAllOrDirty()
boolean	isDirty()
boolean	isNone()
boolean	isVersion()
static OptimisticLockStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OptimisticLockStyle[]	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 OptimisticLockStyle NONE

No optimistic locking.

VERSION

public static final OptimisticLockStyle VERSION

Optimistic locking via a dedicated version or timestamp column.

DIRTY

public static final OptimisticLockStyle DIRTY

Optimistic locking via comparison of dirty columns.

ALL

public static final OptimisticLockStyle ALL

Optimistic locking via comparison of all columns.

Method Detail

values

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

Returns:

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

valueOf

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

fromLockType

public static OptimisticLockStyle fromLockType(OptimisticLockType type)

isAllOrDirty

public boolean isAllOrDirty()

isAll

public boolean isAll()

isDirty

public boolean isDirty()

isVersion

public boolean isVersion()

isNone

public boolean isNone()

getOldCode

@Deprecated(since="6.2",
            forRemoval=true)
public int getOldCode()

Deprecated, for removal: This API element is subject to removal in a future version.

these integer codes have not been used for a long time

interpretOldCode

@Deprecated(since="6.2",
            forRemoval=true)
public static OptimisticLockStyle interpretOldCode(int oldCode)

Deprecated, for removal: This API element is subject to removal in a future version.

these integer codes have not been used for a long time

Given an old code (one of the int constants from Cascade), interpret it as one of the new enums.

Parameters:

oldCode - The old int constant code

Returns:

The interpreted enum value

Throws:

IllegalArgumentException - If the code did not match any legacy constant.