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

Enum DocumentRefreshStrategy

java.lang.Object

java.lang.Enum<DocumentRefreshStrategy>

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

All Implemented Interfaces:

Serializable, Comparable<DocumentRefreshStrategy>

public enum DocumentRefreshStrategy
extends Enum<DocumentRefreshStrategy>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORCE After a change to an indexed document, force a refresh of the corresponding shard to make the updated document searchable immediately, and wait for that refresh to finish.
NONE After a change to an indexed document, simply let the global index refresh policy follow its course, without waiting for anything.

Method Summary

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

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

The updated document may be searchable immediately after the document is updated, or after a short period of time, depending on the backend and index.

FORCE

public static final DocumentRefreshStrategy FORCE

After a change to an indexed document, force a refresh of the corresponding shard to make the updated document searchable immediately, and wait for that refresh to finish.

Method Detail

values

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

Returns:

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

valueOf

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