org.ektorp.docref

Enum FetchType

java.lang.Object

java.lang.Enum<FetchType>

org.ektorp.docref.FetchType

All Implemented Interfaces:

Serializable, Comparable<FetchType>

public enum FetchType
extends Enum<FetchType>

Controls when document referenced documents are loaded.

Author:

ragnar rova

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAGER Load referenced documents when the parent document is loaded.
LAZY Load referenced documents when any method on the annotated collection is called which needs the content.

Method Summary

Methods

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

EAGER

public static final FetchType EAGER

Load referenced documents when the parent document is loaded.

LAZY

public static final FetchType LAZY

Load referenced documents when any method on the annotated collection is called which needs the content.

Method Detail

values

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

Returns:

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

valueOf

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