org.hibernate.search.engine.backend.types

Enum Norms

java.lang.Object

java.lang.Enum<Norms>

org.hibernate.search.engine.backend.types.Norms

All Implemented Interfaces:

Serializable, Comparable<Norms>

public enum Norms
extends Enum<Norms>

Whether index-time scoring information for the field should be stored or not.

Enabling norms will improve the quality of scoring. Disabling norms will reduce the disk space used by the index.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Use the backend-specific default.
NO The index-time scoring information is not stored.
YES The index-time scoring information is stored.

Method Summary

Modifier and Type	Method and Description
static Norms	valueOf(String name) Returns the enum constant of this type with the specified name.
static Norms[]	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

DEFAULT

public static final Norms DEFAULT

Use the backend-specific default.

NO

public static final Norms NO

The index-time scoring information is not stored.

YES

public static final Norms YES

The index-time scoring information is stored.

Method Detail

values

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

Returns:

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

valueOf

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