org.hibernate.search.annotations

Enum Analyze

java.lang.Object

java.lang.Enum<Analyze>

org.hibernate.search.annotations.Analyze

All Implemented Interfaces:

Serializable, Comparable<Analyze>

public enum Analyze
extends Enum<Analyze>

Defines whether the field content should be analyzed.

Author:

Hardy Ferentschik

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO Index field content as is (not analyzed)
YES Analyze the field content

Method Summary

Methods

Modifier and Type	Method and Description
static Analyze	valueOf(String name) Returns the enum constant of this type with the specified name.
static Analyze[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YES

public static final Analyze YES

Analyze the field content

NO

public static final Analyze NO

Index field content as is (not analyzed)

Method Detail

values

public static Analyze[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Analyze c : Analyze.values())
    System.out.println(c);

Returns:

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

valueOf

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

NullPointerException - if the argument is null