org.hibernate.search.engine.backend.work.execution

Enum DocumentCommitStrategy

java.lang.Object

java.lang.Enum<DocumentCommitStrategy>

org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy

All Implemented Interfaces:

Serializable, Comparable<DocumentCommitStrategy>

public enum DocumentCommitStrategy
extends Enum<DocumentCommitStrategy>

Defines how to handle index commits after a document is written to the index, i.e. whether changes should be committed to disk immediately or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORCE After a change to an indexed document, force a commit of the relevant shard and wait for that commit to finish, to ensure changes are persisted to disk.
NONE After a change to an indexed document, simply let the global index commit policy follow its course, without waiting for or forcing a commit.

Method Summary

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

After a change to an indexed document, simply let the global index commit policy follow its course, without waiting for or forcing a commit.

If the backend fails before committing the changes to the document, the changes may be lost.

FORCE

public static final DocumentCommitStrategy FORCE

After a change to an indexed document, force a commit of the relevant shard and wait for that commit to finish, to ensure changes are persisted to disk.

Method Detail

values

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

Returns:

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

valueOf

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