com.neeve.aep
Enum AepEngine.State

java.lang.Object
  extended by java.lang.Enum<AepEngine.State>
      extended by com.neeve.aep.AepEngine.State
All Implemented Interfaces:
Serializable, Comparable<AepEngine.State>
Enclosing class:
AepEngine

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

Enumerates an AEP engine's state.


Enum Constant Summary
Init
          Indicates an engine has been created but not started.
Started
          Indicates an engine has been started and is operational.
Starting
          Indicates an engine is being started.
Stopped
          Indicates that an engine has been stopped.
Stopping
          Indicates an engine is being stopped.
 
Method Summary
static AepEngine.State valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AepEngine.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
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Init

public static final AepEngine.State Init
Indicates an engine has been created but not started.


Starting

public static final AepEngine.State Starting
Indicates an engine is being started.


Started

public static final AepEngine.State Started
Indicates an engine has been started and is operational.

A started engine does not indicate that its messaging has been started. Whether an engine's messaging has been started or not is indicated by its AepEngine.MessagingState. For example, a backup cluster instance may be started but will wait on a role change to primary to start its messaging.


Stopping

public static final AepEngine.State Stopping
Indicates an engine is being stopped.


Stopped

public static final AepEngine.State Stopped
Indicates that an engine has been stopped.

Method Detail

values

public static AepEngine.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 (AepEngine.State c : AepEngine.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 AepEngine.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


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.