org.hibernate.search.backend.elasticsearch.cfg

Enum IndexManagementStrategy

java.lang.Object

java.lang.Enum<IndexManagementStrategy>

org.hibernate.search.backend.elasticsearch.cfg.IndexManagementStrategy

All Implemented Interfaces:

Serializable, Comparable<IndexManagementStrategy>

public enum IndexManagementStrategy
extends Enum<IndexManagementStrategy>

Strategy for creating/deleting the indexes in Elasticsearch upon session factory initialization and shut-down.

Author:

Gunnar Morling

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE Indexes - and all their contents - will be deleted and newly created upon session factory initialization.
CREATE_DELETE The same as CREATE, but indexes - and all their contents - will be deleted upon session factory shut-down.
MERGE Upon session factory initialization, index mappings will be merged with existing ones, causing an exception if a mapping to be merged is not compatible with the existing one.
NONE Indexes will never be created or deleted.

Method Summary

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

NONE

public static final IndexManagementStrategy NONE

Indexes will never be created or deleted.

MERGE

public static final IndexManagementStrategy MERGE

Upon session factory initialization, index mappings will be merged with existing ones, causing an exception if a mapping to be merged is not compatible with the existing one. Missing indexes and mappings will be created.

CREATE

public static final IndexManagementStrategy CREATE

Indexes - and all their contents - will be deleted and newly created upon session factory initialization.

CREATE_DELETE

public static final IndexManagementStrategy CREATE_DELETE

The same as CREATE, but indexes - and all their contents - will be deleted upon session factory shut-down.

Method Detail

values

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

Returns:

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

valueOf

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