Enum Class CacheStartupState

java.lang.Object

java.lang.Enum<CacheStartupState>

org.infinispan.manager.CacheStartupState

All Implemented Interfaces:

Serializable, Comparable<CacheStartupState>, Constable

public enum CacheStartupState
extends Enum<CacheStartupState>

Tracks the startup state of a cache during container initialization.

State transitions:

  STARTING -> READY   (cache started successfully)
  STARTING -> FAILED   (cache startup threw an exception, or shutdown occurred)

Terminal states (READY and FAILED) are never revisited.

Since:

16.2

Author:

José Bolina

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The cache failed to start.
READY	The cache started successfully and is available to serve requests.
STARTING	The cache has been submitted for startup and initialization is in progress.

Method Summary

Modifier and Type	Method	Description
static CacheStartupState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CacheStartupState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STARTING

public static final CacheStartupState STARTING

The cache has been submitted for startup and initialization is in progress. This includes component wiring, state transfer, and persistence loading. The cache is not ready for use yet.

READY

public static final CacheStartupState READY

The cache started successfully and is available to serve requests.

FAILED

public static final CacheStartupState FAILED

The cache failed to start. The failure is logged and does not affect other caches or the cache manager. The cache can be retried manually via EmbeddedCacheManager.getCache(String).

Method Details

values

public static CacheStartupState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CacheStartupState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null