org.hibernate.search.engine.search.predicate

Enum DslConverter

java.lang.Object

java.lang.Enum<DslConverter>

org.hibernate.search.engine.search.predicate.DslConverter

All Implemented Interfaces:

Serializable, Comparable<DslConverter>

public enum DslConverter
extends Enum<DslConverter>

Allows to specify whether values passed to the DSL should be converted using the DSL converter defined in the mapping.

Enum Constant Summary

Enum Constants

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

Method Summary

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

Enable the DSL converter.

This generally means the values passed to the DSL are expected to have the exact same type as the entity property used to populate the index field.

To be more specific, it means the converter passed to IndexFieldTypeConverterContext.dslConverter(ToDocumentFieldValueConverter) will be applied to values passed to the DSL in order to get a value that the backend can understand.

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

Please refer to the reference documentation for more information.

DISABLED

public static final DslConverter DISABLED

Disable the DSL converter.

This generally means the values passed to the DSL are expected to have the exact same type as the index field.

To be more specific, it means the converter passed to IndexFieldTypeConverterContext.dslConverter(ToDocumentFieldValueConverter) will not be applied to values.

Please refer to the reference documentation for more information.

Method Detail

values

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

Returns:

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

valueOf

public static DslConverter 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()