Package ch.systemsx.cisd.common.exceptions

Enum StatusFlag

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StatusFlag>
    public enum StatusFlag
extends java.lang.Enum<StatusFlag>
    The status of an operation. To be used whenever a failure of an operation is signaled back via a return value rather than an exception.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ERROR
      An error has occurred.
      OK
      The operation has been successful.
      RETRIABLE_ERROR
      An error has occurred.

    • Method Summary

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

    • Enum Constant Detail

      • OK

        public static final StatusFlag OK
        The operation has been successful.

      • RETRIABLE_ERROR

        public static final StatusFlag RETRIABLE_ERROR
        An error has occurred. Retrying the operation might remove the problem.

      • ERROR

        public static final StatusFlag ERROR
        An error has occurred.

    • Method Detail

      • values

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

      • valueOf

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