EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.annotations
Enum JoinFetchType

java.lang.Object
  extended by java.lang.Enum<JoinFetchType>
      extended by org.eclipse.persistence.annotations.JoinFetchType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<JoinFetchType>

public enum JoinFetchType
extends java.lang.Enum<JoinFetchType>

An enum type that is used within the JoinFetch annotation.

See Also:
JoinFetch
Author:
James Sutherland
Since:
Oracle TopLink 11.1.1.0.0

Enum Constant Summary
INNER
          An inner join is used to fetch the related object.
OUTER
          An inner join is used to fetch the related object.
 
Method Summary
static JoinFetchType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static JoinFetchType[] 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

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 Detail

values

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

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

valueOf

public static JoinFetchType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference