org.compass.annotations
Enum ExcludeFromAll

java.lang.Object
  java.lang.Enum<ExcludeFromAll>
      org.compass.annotations.ExcludeFromAll

All Implemented Interfaces:

Serializable, Comparable<ExcludeFromAll>

public enum ExcludeFromAll
extends Enum<ExcludeFromAll>

Specifies if a certain property should be excluded from all property or not.

Author:

kimchy

Enum Constant Summary

NO
The property will not be excluded from all.

NO_ANALYZED
The property will not be excluded from all.

YES
The property will be exlcuded from all.

Method Summary

static ExcludeFromAll	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExcludeFromAll[]	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

NO

public static final ExcludeFromAll NO

The property will not be excluded from all. If this property is "not_analyzed" it will be added as is to the all property without being analyzed/tokenized.

NO_ANALYZED

public static final ExcludeFromAll NO_ANALYZED

The property will not be excluded from all. If this property is "not_analyzed" it will be added as is to the all property after being analyzed.

YES

public static final ExcludeFromAll YES

The property will be exlcuded from all.

Method Detail

values

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

Returns:

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

valueOf

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