Package org.infinispan.configuration.cache

Enum IndexStartupMode

java.lang.Object

java.lang.Enum<IndexStartupMode>

org.infinispan.configuration.cache.IndexStartupMode

All Implemented Interfaces:

Serializable, Comparable<IndexStartupMode>

public enum IndexStartupMode
extends Enum<IndexStartupMode>

Allows to define some mass indexing operations (e.g.: purge or reindex) to trigger when the cache starts. These actions are usually needed to keep data and indexes aligned (consistent).

Since:

14.0

Author:

Fabio Massimo Ercoli <fabiomassimo.ercoli@gmail.com>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	With this configuration Infinispan will try to run the right action to align cache data and indexes.
NONE	No mass-indexing operation is triggered at cache startup time.
PURGE	Purge will be triggered at cache startup time.
REINDEX	Reindex will be triggered at cache startup time.

Method Summary

Modifier and Type	Method	Description
static IndexStartupMode	requireValid(String value, org.infinispan.util.logging.Log logger)
static IndexStartupMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexStartupMode[]	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

PURGE

public static final IndexStartupMode PURGE

Purge will be triggered at cache startup time.

REINDEX

public static final IndexStartupMode REINDEX

Reindex will be triggered at cache startup time.

AUTO

public static final IndexStartupMode AUTO

With this configuration Infinispan will try to run the right action to align cache data and indexes. Purge will be triggered if the cache data is volatile and indexes are not. Reindex will be triggered if the cache data is not volatile and indexes are.

NONE

public static final IndexStartupMode NONE

No mass-indexing operation is triggered at cache startup time. This is the default.

Method Detail

values

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

Returns:

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

valueOf

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

requireValid

public static IndexStartupMode requireValid(String value,
                                            org.infinispan.util.logging.Log logger)