Package org.hibernate.boot.model.internal

Enum Class ForeignKeyType

java.lang.Object

java.lang.Enum<ForeignKeyType>

org.hibernate.boot.model.internal.ForeignKeyType

All Implemented Interfaces:

Serializable, Comparable<ForeignKeyType>, Constable

public enum ForeignKeyType
extends Enum<ForeignKeyType>

Specifies the sort of foreign key reference given in a JoinColumn annotation.

Author:

Gavin King

See Also:

• AnnotatedJoinColumns.getReferencedColumnsType(PersistentClass)

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
EXPLICIT_PRIMARY_KEY_REFERENCE
IMPLICIT_PRIMARY_KEY_REFERENCE
NON_PRIMARY_KEY_REFERENCE

Method Summary

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

EXPLICIT_PRIMARY_KEY_REFERENCE

public static final ForeignKeyType EXPLICIT_PRIMARY_KEY_REFERENCE

IMPLICIT_PRIMARY_KEY_REFERENCE

public static final ForeignKeyType IMPLICIT_PRIMARY_KEY_REFERENCE

NON_PRIMARY_KEY_REFERENCE

public static final ForeignKeyType NON_PRIMARY_KEY_REFERENCE

Method Details

values

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