Package 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 specifies two distinct ways to apply an EntityGraph - as a "fetch graph" or as a "load graph".

Enum Constant Summary

Enum Constants

Enum Constant	Description
FETCH	Indicates that an EntityGraph should be interpreted as a JPA "fetch graph".
LOAD	Indicates that an EntityGraph should be interpreted as a JPA "load graph".

Method Summary

Modifier and Type	Method	Description
static GraphSemantic	fromHintName(String hintName)
static GraphSemantic	fromJpaHintName(String hintName)	Deprecated. Use fromHintName(java.lang.String) instead
String	getJakartaHintName()	The corresponding Jakarta Persistence hint name.
String	getJpaHintName()	Deprecated. Use getJakartaHintName() instead
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 that an EntityGraph should be interpreted as a JPA "fetch graph".

• Attributes explicitly specified using an AttributeNodes are treated as FetchType.EAGER and fetched via a join or subsequent select.
• Attributes not explicitly specified are treated as FetchType.LAZY and are not fetched.

LOAD

public static final GraphSemantic LOAD

Indicates that an EntityGraph should be interpreted as a JPA "load graph".

• Attributes explicitly specified using an AttributeNodes are treated as FetchType.EAGER and fetched via a join or subsequent select.
• Attributes not explicitly specified are treated as FetchType.LAZY or FetchType.EAGER depending on the mapping of the attribute, instead of forcing FetchType.LAZY.

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

getJakartaHintName

public String getJakartaHintName()

The corresponding Jakarta Persistence hint name.

See Also:

SpecHints.HINT_SPEC_FETCH_GRAPH, SpecHints.HINT_SPEC_LOAD_GRAPH

getJpaHintName

@Deprecated(since="6.0")
public String getJpaHintName()

Deprecated.

Use getJakartaHintName() instead

The hint name that should be used with Java Persistence.

See Also:

LegacySpecHints.HINT_JAVAEE_FETCH_GRAPH, LegacySpecHints.HINT_JAVAEE_LOAD_GRAPH

fromHintName

public static GraphSemantic fromHintName(String hintName)

fromJpaHintName

@Deprecated(since="6.0")
public static GraphSemantic fromJpaHintName(String hintName)

Deprecated.

Use fromHintName(java.lang.String) instead