org.compass.annotations
Enum Reverse

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

All Implemented Interfaces:

Serializable, Comparable<Reverse>

public enum Reverse
extends Enum<Reverse>

Specifies whether and how the meta-data proeprty should value will be revered.

Author:

kimchy

Enum Constant Summary

NO
No reversing will happen on the meta-data value.

READER
A special reader will wrap the actual string value, and reverse it.

STRING
A new string will be used to hold the reverse value of the meta-data.

Method Summary

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

No reversing will happen on the meta-data value.

READER

public static final Reverse READER

A special reader will wrap the actual string value, and reverse it. More performant than the STRING option, but means that it will always be Index.ANALYZED and Store.NO.

STRING

public static final Reverse STRING

A new string will be used to hold the reverse value of the meta-data. Less performant than the READER option, but allows to control the Index and the Store.

Method Detail

values

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

Returns:

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

valueOf

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