com.apama.services.scenario
Enum DiscoveryStatusEnum

java.lang.Object
  java.lang.Enum<DiscoveryStatusEnum>
      com.apama.services.scenario.DiscoveryStatusEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DiscoveryStatusEnum>

public enum DiscoveryStatusEnum
extends java.lang.Enum<DiscoveryStatusEnum>

Enum to represent the discovery status within the Scenario Service.

The possible String value of the states are "pending", "active" and "complete".

The are three static instances of the class, one for each element in the enum.

• PENDING indicates that the discovery process has not yet started. Possible next states: ACTIVE.
• ACTIVE indicates that the discovery process has started but is not yet complete. Possible next states: PENDING, COMPLETE.
• COMPLETE indicates that the discovery process is complete. Possible next states: PENDING.

In releases prior to Apama 3.0, this was a class in the form of the standard type-safe enum pattern, but has been upgraded to a new style Java enum once the Java 5 language features were permitted in our code-base.

Enum Constant Summary

ACTIVE

COMPLETE

PENDING

Method Summary

static DiscoveryStatusEnum	fromString(java.lang.String stateString) Get the enumeration value that corresponds to the given string.
java.lang.String	toString() Retrieve the String representation of the DiscoveryStateEnum enum object.
static DiscoveryStatusEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DiscoveryStatusEnum[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PENDING

public static final DiscoveryStatusEnum PENDING

ACTIVE

public static final DiscoveryStatusEnum ACTIVE

COMPLETE

public static final DiscoveryStatusEnum COMPLETE

Method Detail

values

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

Returns:

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

valueOf

public static DiscoveryStatusEnum valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Retrieve the String representation of the DiscoveryStateEnum enum object.

Overrides:

toString in class java.lang.Enum<DiscoveryStatusEnum>

Returns:

the String representation of the DiscoveryStateEnum enum object.

fromString

public static DiscoveryStatusEnum fromString(java.lang.String stateString)
                                      throws java.lang.IllegalArgumentException

Get the enumeration value that corresponds to the given string.

Parameters:

stateString - A String for which a valid enumeration element is required.

Returns:

The static DiscoveryStateEnum instance that represents the given String.

Throws:

java.lang.IllegalArgumentException - if the parameter does not match a valid enumeration element.