org.hibernate.search.engine.search.projection

Enum ProjectionConverter

java.lang.Object

java.lang.Enum<ProjectionConverter>

org.hibernate.search.engine.search.projection.ProjectionConverter

All Implemented Interfaces:

Serializable, Comparable<ProjectionConverter>

public enum ProjectionConverter
extends Enum<ProjectionConverter>

Allows to specify whether projected values should be converted using the projection converter defined in the mapping.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Disable the projection converter.
ENABLED Enable the projection converter.

Method Summary

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

ENABLED

public static final ProjectionConverter ENABLED

Enable the projection converter.

This generally means the projected values will have the same type as the entity property used to populate the index field.

To be more specific, it means the converter passed to IndexFieldTypeConverterStep.projectionConverter(FromDocumentFieldValueConverter) will be applied to projected values before returning them.

If no projection converter was defined, this option won't have any effect.

Please refer to the reference documentation for more information.

DISABLED

public static final ProjectionConverter DISABLED

Disable the projection converter.

This generally means the projected values will have the same type as the index field.

To be more specific, it means the converter passed to IndexFieldTypeConverterStep.projectionConverter(FromDocumentFieldValueConverter) will not be applied to projected values before returning them.

Please refer to the reference documentation for more information.

Method Detail

values

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

Returns:

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

valueOf

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

isEnabled

public boolean isEnabled()