Enum Constant Detail

• CREATED

  public static final Lifecycle CREATED

  The entity has just been created. This stage encompasses the contruction. Once this stage is complete, the basic set of Sensors will be available, apart from any that require the entity to be active or deployed to a Location.

• STARTING

  public static final Lifecycle STARTING

  The entity is starting.

  This stage is typically entered when the Startable.START Effector is called, to undertake the startup operations from the management plane. When this completes the entity will normally transition to RUNNING.

• RUNNING

  public static final Lifecycle RUNNING

  The entity service is expected to be running. In healthy operation, Attributes.SERVICE_UP will be true, or will shortly be true if all service start actions have been completed and we are merely waiting for it to be running.

• STOPPING

  public static final Lifecycle STOPPING

  The entity is stopping. This stage is activated when the Startable.STOP effector is called. The entity service is stopped. Sensors that provide data from the running entity may be cleared and subscriptions cancelled.

• STOPPED

  public static final Lifecycle STOPPED

  The entity is not expected to be active. This stage is entered when an entity is stopped, or may be entered when an entity is fully created but not started. It may or may not be removed from the location(s) it was assigned, and it will typically not be providing new sensor data apart.

• DESTROYED

  public static final Lifecycle DESTROYED

  The entity is destroyed. The entity will be unmanaged and removed from any groups and from its parent.

• ON_FIRE

  public static final Lifecycle ON_FIRE

  Entity error state. This stage is reachable from any other stage if an error occurs or an exception is thrown.

Method Detail

• values

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

  Returns:

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

• valueOf

  public static Lifecycle 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

• value

  public java.lang.String value()

  The text representation of the Enum.name(). This is formatted as lower case characters, with hyphens instead of spaces.

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Enum<Lifecycle>

  See Also:

  value()

• fromValue

  public static Lifecycle fromValue(java.lang.String v)

  Creates a Lifecycle from a text representation. This accepts the text representations output by the value() method for each entry.

  See Also:

  value()