Enum Class KeyType

java.lang.Object

java.lang.Enum<KeyType>

org.hibernate.KeyType

All Implemented Interfaces:

FindOption, Serializable, Comparable<KeyType>, Constable

public enum KeyType
extends Enum<KeyType>
implements FindOption

FindOption allowing to load based on either id (default) or natural-id.

Since:

7.3

See Also:

• EntityManager.find(Class, Object)
• Session.findMultiple(Class, List, FindOption...)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IDENTIFIER	Indicates to find by the entity's identifier.
NATURAL	Indicates to find based on the entity's natural-id, if one.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDENTIFIER

public static final KeyType IDENTIFIER

Indicates to find by the entity's identifier. The default.

See Also:

• Id
• EmbeddedId
• IdClass

NATURAL

public static final KeyType NATURAL

Indicates to find based on the entity's natural-id, if one.

See Also:

• NaturalId
• NaturalIdClass

Implementation Specification:

Will trigger an IllegalArgumentException if the entity does not define a natural-id.

Method Details

values

public static KeyType[] 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 KeyType 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