Module eclipselink

Package org.eclipse.persistence.annotations

Enum Class JoinFetchType

java.lang.Object

java.lang.Enum<JoinFetchType>

org.eclipse.persistence.annotations.JoinFetchType

All Implemented Interfaces:

Serializable, Comparable<JoinFetchType>, Constable

public enum JoinFetchType
extends Enum<JoinFetchType>

An enum type that is used within the JoinFetch annotation.

See Also:

• JoinFetch

Author:

James Sutherland

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
INNER	An inner join is used to fetch the related object.
OUTER	An inner join is used to fetch the related object.

Method Summary

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

INNER

public static final JoinFetchType INNER

An inner join is used to fetch the related object.

This does not allow for null/empty values.

OUTER

public static final JoinFetchType OUTER

An inner join is used to fetch the related object.

This allows for null/empty values.

Method Details

values

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