org.hibernate.boot.model.source.spi

Enum NaturalIdMutability

java.lang.Object

java.lang.Enum<NaturalIdMutability>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NaturalIdMutability>

public enum NaturalIdMutability
extends java.lang.Enum<NaturalIdMutability>

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static NaturalIdMutability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NaturalIdMutability[]	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

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 Detail

values

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

Returns:

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

valueOf

public static NaturalIdMutability valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null