Module org.cruk.clarity.api
Package com.genologics.ri.container

Enum ContainerState

java.lang.Object
java.lang.Enum<ContainerState>
com.genologics.ri.container.ContainerState
All Implemented Interfaces:
Serializable, Comparable<ContainerState>, java.lang.constant.Constable
public enum ContainerState extends Enum<ContainerState>
An enumeration of the values possible in the Container.state attribute. This enumeration isn't actually an enumeration in the XML schemas, but it has a finite set of possible values and it's easier to work with an enumeration in Java code than just a string.
Since:
2.31.6

  • Enum Constant Details

    • EMPTY

      public static final ContainerState EMPTY
      The container state when the container is empty.

    • POPULATED

      public static final ContainerState POPULATED
      The container state when the container has something in it.

    • DEPLETED

      public static final ContainerState DEPLETED
      The container state when the container is depleted.

    • DISCARDED

      public static final ContainerState DISCARDED
      The container state when the container has been discarded.

    • REAGENT_ONLY

      public static final ContainerState REAGENT_ONLY
      The container state when the container only container reagents.

    • NEW

      public static final ContainerState NEW
      The container state when the container is newly created.

    • HYBRIDIZED

      public static final ContainerState HYBRIDIZED
      The container state when the container's contents have been hybridized.

    • SCANNED

      public static final ContainerState SCANNED
      The container state when the container's contents have been scanned.

  • Field Details

    • displayName

      public final String displayName
      The display name of the state.

    • stateId

      public final int stateId
      The numeric state id for the container state, as stored in the database.

  • Method Details

    • values

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

    • valueOf

      public static ContainerState valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ContainerState>

    • value

      public String value()

    • fromValue

      public static ContainerState fromValue(String str)
      Get the container state that has the given display name.
      Parameters:
      str - The display name, as returned from Clarity calls.
      Returns:
      The matching process state, or null if str is null.
      Throws:
      IllegalArgumentException - if str does not match the display name of a state.