org.apache.openjpa.persistence.jdbc
Enum FetchMode

java.lang.Object
  java.lang.Enum<FetchMode>
      org.apache.openjpa.persistence.jdbc.FetchMode

All Implemented Interfaces:

Serializable, Comparable<FetchMode>, OpenJPAEnum<FetchMode>

public enum FetchMode
extends Enum<FetchMode>
implements OpenJPAEnum<FetchMode>

Type of fetching to employ.

Since:

0.4.0

Author:

Abe White

Enum Constant Summary

JOIN

NONE

PARALLEL

Method Summary

int	convertToKernelConstant(int i) Convert the given integer to an equivalent kernel constant.
int	convertToKernelConstant(String s) Convert the given String to an equivalent kernel constant.
(package private) static FetchMode	fromKernelConstant(int kernelConstant)
int	toKernelConstant() Convert this receiver to an equivalent kernel constant.
static int	toKernelConstantFromString(String s)
static FetchMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FetchMode[]	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

NONE

public static final FetchMode NONE

JOIN

public static final FetchMode JOIN

PARALLEL

public static final FetchMode PARALLEL

Method Detail

values

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

Returns:

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

valueOf

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

toKernelConstant

public int toKernelConstant()

Description copied from interface: OpenJPAEnum

Convert this receiver to an equivalent kernel constant.

Specified by:

toKernelConstant in interface OpenJPAEnum<FetchMode>

fromKernelConstant

static FetchMode fromKernelConstant(int kernelConstant)

convertToKernelConstant

public int convertToKernelConstant(String s)

Description copied from interface: OpenJPAEnum

Convert the given String to an equivalent kernel constant. This method has a static semantics in the sense that it can be invoked on any enum instance, but the conversion is done w.r.t. all enums of the generic type.

Specified by:

convertToKernelConstant in interface OpenJPAEnum<FetchMode>

convertToKernelConstant

public int convertToKernelConstant(int i)

Description copied from interface: OpenJPAEnum

Convert the given integer to an equivalent kernel constant. This method has a static semantics in the sense that it can be invoked on any enum instance, but the conversion is done w.r.t. all enums of the generic type.

Specified by:

convertToKernelConstant in interface OpenJPAEnum<FetchMode>

toKernelConstantFromString

public static int toKernelConstantFromString(String s)