Enum StateEvent

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StateEvent>, EventLabel

    public enum StateEvent
    extends java.lang.Enum<StateEvent>
    implements EventLabel
    $Id: StateEvent.java 1714M 2012-01-17 08:29:30Z (local) $

    Defines standard state events.

    Since:
    0.5
    Author:
    Lionel Armanet
    • Method Summary

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

      • values

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

        public static StateEvent 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
      • getEventLabel

        public java.lang.String getEventLabel()
        Specified by:
        getEventLabel in interface EventLabel
        Returns:
        The event string label