Package com.apama.services.scenario

Enum InstanceStateEnum

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<InstanceStateEnum>
    public enum InstanceStateEnum
extends java.lang.Enum<InstanceStateEnum>
    Enum class to handle the StateChange event.

    The possible String value of the States are "RUNNING", "ENDED" and "FAILED".

    • "RUNNING" is the default state when an Instance is created.
    • "ENDED" when the instance reaches the END.
    • "FAILED" when the instance died unexpectedly.

    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.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static InstanceStateEnum 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 InstanceStateEnum object.
      static InstanceStateEnum valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static InstanceStateEnum[] 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

    • Method Detail

      • values

        public static InstanceStateEnum[] 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 (InstanceStateEnum c : InstanceStateEnum.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static InstanceStateEnum 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 InstanceStateEnum object.
        Overrides:
        toString in class java.lang.Enum<InstanceStateEnum>
        Returns:
        the String representation of the InstanceStateEnum object.

      • fromString

        public static InstanceStateEnum 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 InstanceStateEnum instance that represents the given String.
        Throws:
        java.lang.IllegalArgumentException - if the parameter does not match a valid enumeration element.