org.hibernate.search.mapper.pojo.extractor.mapping.annotation

Enum ContainerExtract

java.lang.Object

java.lang.Enum<ContainerExtract>

org.hibernate.search.mapper.pojo.extractor.mapping.annotation.ContainerExtract

All Implemented Interfaces:

Serializable, Comparable<ContainerExtract>

public enum ContainerExtract
extends Enum<ContainerExtract>

Control how values are extracted from a POJO property of container type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT If extractors are defined explicitly, apply those.
NO Do not apply any container extractor, and throw an exception if extractors are defined explicitly.

Method Summary

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

If extractors are defined explicitly, apply those. Otherwise, automatically and recursively resolve extractors according to the type of the property: get elements for collections, values for maps, ...

NO

public static final ContainerExtract NO

Do not apply any container extractor, and throw an exception if extractors are defined explicitly.

Method Detail

values

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

Returns:

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

valueOf

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