org.compass.annotations
Enum ExcludeAlias

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

public enum ExcludeAlias
extends Enum<ExcludeAlias>

Controls if the all property will exclude the alias from it

Author:
kimchy

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

See Also:
CompassEnvironment.All.EXCLUDE_ALIAS

TRUE

public static final ExcludeAlias TRUE
Alias will be excluded for this mapping. Regardless of the globabl setting.


FALSE

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

Method Detail

values

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

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

valueOf

public static ExcludeAlias 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-2008 The Compass Project.