com.ibm.websphere.objectgrid.plugins
Enum BackingMapLifecycleListener.State

java.lang.Object
  java.lang.Enum<BackingMapLifecycleListener.State>
      com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.State

All Implemented Interfaces:

Serializable, Comparable<BackingMapLifecycleListener.State>

Enclosing interface:

BackingMapLifecycleListener

public static enum BackingMapLifecycleListener.State
extends Enum<BackingMapLifecycleListener.State>

The state of a BackingMap's life cycle.

Enum Constant Summary

DESTROYED
The BackingMap instance and all BackingMap plug-ins have been destroyed.

DESTROYING
The BackingMap instance is starting the destroy phase.

INITIALIZED
The BackingMap initialization phase is complete.

INITIALIZING
The BackingMap instance initialization phase is starting.

NEW
The BackingMap instance has been created.

OFFLINE
All work is stopped on the BackingMap as a result of the StateManager API or other event.

ONLINE
The BackingMap instance is ready for work as a local instance, client instance or an instance in a primary or replica shard on the server.

PRELOAD
The BackingMap instance is set to the PRELOAD state by the StateManager API for preload, or is performing preload using the configured Loader.

QUIESCE
Work is stopping on the BackingMap as a result of the StateManager API or other event.

STARTING
The BackingMap instance is being activated for use in a local instance, client instance or as an instance in a primary or replica shard on the server.

Method Summary

static BackingMapLifecycleListener.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static BackingMapLifecycleListener.State[]	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

NEW

public static final BackingMapLifecycleListener.State NEW

The BackingMap instance has been created.

INITIALIZING

public static final BackingMapLifecycleListener.State INITIALIZING

The BackingMap instance initialization phase is starting. The BackingMap and BackingMap plug-ins are about to be initialized. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the BackingMap.

INITIALIZED

public static final BackingMapLifecycleListener.State INITIALIZED

The BackingMap initialization phase is complete. All BackingMap plug-ins are initialized. The INITIALIZED state may re-occur when shard placement activities (promotion, demotion) occur. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the BackingMap.

STARTING

public static final BackingMapLifecycleListener.State STARTING

The BackingMap instance is being activated for use in a local instance, client instance or as an instance in a primary or replica shard on the server. All BackingMap plug-ins have been created an initialized. All ObjectGrid plug-ins in the ObjectGrid instance owning this BackingMap instance have been initialized. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the BackingMap.

PRELOAD

public static final BackingMapLifecycleListener.State PRELOAD

The BackingMap instance is set to the PRELOAD state by the StateManager API for preload, or is performing preload using the configured Loader. All BackingMap plug-ins have been created an initialized.

ONLINE

public static final BackingMapLifecycleListener.State ONLINE

The BackingMap instance is ready for work as a local instance, client instance or an instance in a primary or replica shard on the server. This is the typical steady state of the BackingMap. All BackingMap plug-ins have been created an initialized. All ObjectGrid plug-ins in the ObjectGrid instance owning this BackingMap instance have been initialized.

QUIESCE

public static final BackingMapLifecycleListener.State QUIESCE

Work is stopping on the BackingMap as a result of the StateManager API or other event. No new work will be allowed. Your plug-in should end any existing work as soon as possible.

OFFLINE

public static final BackingMapLifecycleListener.State OFFLINE

All work is stopped on the BackingMap as a result of the StateManager API or other event. No new work will be allowed.

DESTROYING

public static final BackingMapLifecycleListener.State DESTROYING

The BackingMap instance is starting the destroy phase. BackingMap plug-ins for the instance are about to be destroyed.

DESTROYED

public static final BackingMapLifecycleListener.State DESTROYED

The BackingMap instance and all BackingMap plug-ins have been destroyed.

Method Detail

values

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

Returns:

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

valueOf

public static BackingMapLifecycleListener.State 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