Module com.genologics.ri
Package com.genologics.ri.container

Enum Class ContainerState

java.lang.Object
java.lang.Enum<ContainerState>
com.genologics.ri.container.ContainerState
All Implemented Interfaces:
Serializable, Comparable<ContainerState>, 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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DEPLETED
    The container state when the container is depleted.
    DISCARDED
    The container state when the container has been discarded.
    EMPTY
    The container state when the container is empty.
    HYBRIDIZED
    The container state when the container's contents have been hybridized.
    NEW
    The container state when the container is newly created.
    POPULATED
    The container state when the container has something in it.
    REAGENT_ONLY
    The container state when the container only container reagents.
    SCANNED
    The container state when the container's contents have been scanned.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    displayName
    The display name of the state.
    final int
    stateId
    The numeric state id for the container state, as stored in the database.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ContainerState
    fromValue(String str)
    Get the container state that has the given display name.
    String
    toString()
    Returns a string representation of the container state.
    String
    value()
    Gets the string value of this container state.
    static ContainerState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ContainerState[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • 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 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 ContainerState 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

    • toString

      public String toString()
      Returns a string representation of the container state.
      Overrides:
      toString in class Enum<ContainerState>
      Returns:
      The display name.

    • value

      public String value()
      Gets the string value of this container state.
      Returns:
      The display name.

    • 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.