org.compass.annotations
Enum SpellCheck

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

public enum SpellCheck
extends Enum<SpellCheck>

Specifies if a certain property should be included in the spell check index.

Note, most times this is not requried to be configured, since by default, the spell check index uses the "all" property.

Author:
kimchy

Enum Constant Summary
EXCLUDE
          Should this proeprty mapping be excluded from the spell check index.
INCLUDE
          Should this property mapping be included in the spell check index.
NA
          NA.
 
Method Summary
static SpellCheck valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SpellCheck[] 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 SpellCheck NA
NA. Has no affect on the spell check and will use external properties configuration.


INCLUDE

public static final SpellCheck INCLUDE
Should this property mapping be included in the spell check index.


EXCLUDE

public static final SpellCheck EXCLUDE
Should this proeprty mapping be excluded from the spell check index.

Method Detail

values

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

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

valueOf

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