org.springframework.data.elasticsearch.annotations

Enum WriteTypeHint

java.lang.Object

java.lang.Enum<WriteTypeHint>

org.springframework.data.elasticsearch.annotations.WriteTypeHint

All Implemented Interfaces:

Serializable, Comparable<WriteTypeHint>

public enum WriteTypeHint
extends Enum<WriteTypeHint>

Defines if type hints should be written. Used by Document annotation.

Since:

4.3

Author:

Peter-Josef Meisch

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Use the global settings from the MappingContext.
FALSE Never write type hints for the entity.
TRUE Always write type hints for the entity.

Method Summary

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

Use the global settings from the MappingContext.

TRUE

public static final WriteTypeHint TRUE

Always write type hints for the entity.

FALSE

public static final WriteTypeHint FALSE

Never write type hints for the entity.

Method Detail

values

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

Returns:

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

valueOf

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