org.hibernate.annotations

Enum LazyToOneOption

java.lang.Object

java.lang.Enum<LazyToOneOption>

org.hibernate.annotations.LazyToOneOption

All Implemented Interfaces:

Serializable, Comparable<LazyToOneOption>

public enum LazyToOneOption
extends Enum<LazyToOneOption>

Lazy options available for a ToOne association.

Author:

Emmanuel Bernard

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE Eagerly load the association.
NO_PROXY Lazy, give back the real object loaded when a reference is requested.
PROXY Lazy, give back a proxy which will be loaded when the state is requested.

Method Summary

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

FALSE

public static final LazyToOneOption FALSE

Eagerly load the association.

PROXY

public static final LazyToOneOption PROXY

Lazy, give back a proxy which will be loaded when the state is requested. This should be the preferred option.

NO_PROXY

public static final LazyToOneOption NO_PROXY

Lazy, give back the real object loaded when a reference is requested. Bytecode enhancement is mandatory for this option. Falls back to PROXY if the class is not enhanced. This option should be avoided unless you can't afford the use of proxies

Method Detail

values

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

Returns:

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

valueOf

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