org.compass.annotations
Enum OmitNorms

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

public enum OmitNorms
extends Enum<OmitNorms>

Author:
kimchy

Enum Constant Summary
NA
          Let Copmass derive the store.
NO
          Do not omit norms.
YES
          Omit norms.
 
Method Summary
static OmitNorms valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OmitNorms[] 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 OmitNorms NA
Let Copmass derive the store. By default, it will be NO.


NO

public static final OmitNorms NO
Do not omit norms.


YES

public static final OmitNorms YES
Omit norms.

Method Detail

values

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

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

valueOf

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