org.hibernate.graph

Enum GraphSemantic

java.lang.Object

java.lang.Enum<GraphSemantic>

org.hibernate.graph.GraphSemantic

All Implemented Interfaces:

Serializable, Comparable<GraphSemantic>

public enum GraphSemantic
extends Enum<GraphSemantic>

JPA defines 2 distinct semantics for applying an EntityGraph. This enumeration captures those 2 semantics.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FETCH Indicates a "fetch graph" EntityGraph.
LOAD Indicates a "load graph" EntityGraph.

Method Summary

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

FETCH

public static final GraphSemantic FETCH

Indicates a "fetch graph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select).

Note: Currently, attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata, rather than forcing FetchType.LAZY.

LOAD

public static final GraphSemantic LOAD

Indicates a "load graph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata

Method Detail

values

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

Returns:

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

valueOf

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

getJpaHintName

public String getJpaHintName()

fromJpaHintName

public static GraphSemantic fromJpaHintName(String hintName)