org.compass.annotations
Enum EnableAll

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

public enum EnableAll
extends Enum<EnableAll>

Controls if the all property will be enabled or not.

Author:
kimchy

Enum Constant Summary
FALSE
          All will be disabled for this mapping.
NA
          Will use Compass globabl setting for all property.
TRUE
          All will be enabled for this mapping.
 
Method Summary
static EnableAll valueOf(String name)
          Returns the enum constant of this type with the specified name.
static EnableAll[] 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 EnableAll NA
Will use Compass globabl setting for all property.

See Also:
CompassEnvironment.All.ENABLED

TRUE

public static final EnableAll TRUE
All will be enabled for this mapping. Regardless of the globabl setting.


FALSE

public static final EnableAll FALSE
All will be disabled for this mapping. Regardless of the globabl setting.

Method Detail

values

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

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

valueOf

public static EnableAll 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.