Package org.hibernate.search.engine.backend.document.model.spi

Enum IndexFieldFilter

java.lang.Object

java.lang.Enum<IndexFieldFilter>

org.hibernate.search.engine.backend.document.model.spi.IndexFieldFilter

All Implemented Interfaces:

Serializable, Comparable<IndexFieldFilter>

public enum IndexFieldFilter
extends Enum<IndexFieldFilter>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Returns all fields independently from their inclusion.
INCLUDED_ONLY	Returns fields that are actually included in the schema.

Method Summary

Modifier and Type	Method	Description
abstract <T> T	filter(T field, IndexFieldInclusion inclusion)
static IndexFieldFilter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexFieldFilter[]	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

ALL

public static final IndexFieldFilter ALL

Returns all fields independently from their inclusion.

INCLUDED_ONLY

public static final IndexFieldFilter INCLUDED_ONLY

Returns fields that are actually included in the schema.

Method Detail

values

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

Returns:

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

valueOf

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

filter

public abstract <T> T filter(T field,
                             IndexFieldInclusion inclusion)

Type Parameters:

T - The type of field.

Parameters:

field - The field to filter.

inclusion - The inclusion of that field (see IndexCompositeNodeBuilder.addField(String, IndexFieldInclusion, IndexFieldType) for example).

Returns:

field if it is included; null otherwise.