Enum Class ServerActiveStatus

java.lang.Object
java.lang.Enum<ServerActiveStatus>
org.odpi.openmetadata.serveroperations.properties.ServerActiveStatus
All Implemented Interfaces:
Serializable, Comparable<ServerActiveStatus>, Constable

public enum ServerActiveStatus extends Enum<ServerActiveStatus>
Server active status defines the state of the server (or a service) on a single platform.
  • Enum Constant Details

    • UNKNOWN

      public static final ServerActiveStatus UNKNOWN
      Unknown - The state of the server is unknown. This is equivalent to a null value.
    • STARTING

      public static final ServerActiveStatus STARTING
      Starting - The server is starting.
    • RUNNING

      public static final ServerActiveStatus RUNNING
      Running - The server has completed start up and is running.
    • STOPPING

      public static final ServerActiveStatus STOPPING
      Stopping - The server has received a request to shut down.
    • INACTIVE

      public static final ServerActiveStatus INACTIVE
      Inactive - The server is not running.
  • Method Details

    • values

      public static ServerActiveStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ServerActiveStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • getOrdinal

      public int getOrdinal()
      Return the code for this enum used for indexing based on the enum value.
      Returns:
      int code number
    • getName

      public String getName()
      Return the default name for this enum type.
      Returns:
      String name
    • getDescription

      public String getDescription()
      Return the default description for this enum.
      Returns:
      String description
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<ServerActiveStatus>
      Returns:
      print out of variables in a JSON-style