com.neeve.aep
Enum AepEngine.StartupExpectation

java.lang.Object
  java.lang.Enum<AepEngine.StartupExpectation>
      com.neeve.aep.AepEngine.StartupExpectation

All Implemented Interfaces:

Serializable, Comparable<AepEngine.StartupExpectation>

Enclosing class:

AepEngine

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

Enumerates the set of startup expectations that can be requested.

This enumerates the various startup expectations that can be requested when starting an engine. A startup expectation is an expectation of the state of an engine and/or it environment when it is starting up. An engine provided an expectation when starting will fail to start if the expectation is not met.

Enum Constant Summary

LogEmptiness
Used to specify the expectation of an engine store's log emptiness state.

Role
Used to specify the expectation of an engine's role on startup.

Method Summary

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

Role

public static final AepEngine.StartupExpectation Role

Used to specify the expectation of an engine's role on startup.

This value is used to specify the expectation of an engine's role on engine startup. The permissible values associated with this expectation are the enumerated store binding role values.

See Also:

IStoreBinding.Role

LogEmptiness

public static final AepEngine.StartupExpectation LogEmptiness

Used to specify the expectation of an engine store's log emptiness state.

This value is used to specify the expectation of the log emptiness state of an engine's store at engine startup. Permissible values are enumerated by the store persister log emptiness expectation enumeration.

See Also:

IStorePersister.LogEmptinessExpectation

Method Detail

values

public static AepEngine.StartupExpectation[] 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.StartupExpectation c : AepEngine.StartupExpectation.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.StartupExpectation 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