org.compass.annotations
Enum Lazy

java.lang.Object
  extended by java.lang.Enum<Lazy>
      extended by org.compass.annotations.Lazy
All Implemented Interfaces:
Serializable, Comparable<Lazy>

public enum Lazy
extends Enum<Lazy>

Defines if a mapping is lazy or not.

Author:
kimchy

Enum Constant Summary
FALSE
          This reference mapping (only in case of collection) will not be lazy.
NA
          NA.
TRUE
          This reference mapping (only in case of collection) will be lazy.
 
Method Summary
static Lazy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Lazy[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NA

public static final Lazy NA
NA. Has no affect on lazy setting and defaults to the global setting.

See Also:
CompassEnvironment.Osem.LAZY_REFERNCE

TRUE

public static final Lazy TRUE
This reference mapping (only in case of collection) will be lazy.


FALSE

public static final Lazy FALSE
This reference mapping (only in case of collection) will not be lazy.

Method Detail

values

public static final Lazy[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Lazy c : Lazy.values())
        System.out.println(c);

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

valueOf

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


Copyright (c) 2004-2009 The Compass Project.