Package org.hibernate.boot.model.source.spi

Enum Class NaturalIdMutability

java.lang.Object

java.lang.Enum<NaturalIdMutability>

org.hibernate.boot.model.source.spi.NaturalIdMutability

All Implemented Interfaces:

Serializable, Comparable<NaturalIdMutability>, Constable

public enum NaturalIdMutability
extends Enum<NaturalIdMutability>

A ternary boolean enum for describing the mutability aspects of an attribute as a natural id.

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
IMMUTABLE	The attribute is part of a immutable natural id
MUTABLE	The attribute is part of a mutable natural id
NOT_NATURAL_ID	The attribute is not part of any kind of natural id.

Method Summary

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

MUTABLE

public static final NaturalIdMutability MUTABLE

The attribute is part of a mutable natural id

IMMUTABLE

public static final NaturalIdMutability IMMUTABLE

The attribute is part of a immutable natural id

NOT_NATURAL_ID

public static final NaturalIdMutability NOT_NATURAL_ID

The attribute is not part of any kind of natural id.

Method Details

values

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