Module jakarta.persistence

Package jakarta.persistence

Enum Class FetchType

java.lang.Object

java.lang.Enum<FetchType>

jakarta.persistence.FetchType

All Implemented Interfaces:

Serializable, Comparable<FetchType>, Constable

public enum FetchType
extends Enum<FetchType>

Defines strategies for fetching data from the database.

• The EAGER strategy is a requirement on the persistence provider runtime that data must be eagerly fetched.
• The LAZY strategy is a hint to the persistence provider runtime that data should be fetched lazily when it is first accessed. The implementation is permitted to eagerly fetch data for which the LAZY strategy hint has been specified.

Example:

@Basic(fetch = LAZY)
protected String getName() { return name; }

Since:

1.0

See Also:

• Basic
• ElementCollection
• ManyToMany
• OneToMany
• ManyToOne
• OneToOne

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
EAGER	Data must be eagerly fetched.
LAZY	Data may be lazily fetched.

Method Summary

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

LAZY

public static final FetchType LAZY

Data may be lazily fetched.

EAGER

public static final FetchType EAGER

Data must be eagerly fetched.

Method Details

values

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