Package com.attivio.sysstate

Enum DocumentState.Status

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DocumentState.Status>
    Enclosing class:
    DocumentState
    public static enum DocumentState.Status
extends java.lang.Enum<DocumentState.Status>
    describes the status of a document or its containing message

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      InitialState
      state is essentially unknown, generally should not occur
      MessageIsBeingProcessed
      in a component instance, but not being processed currently (other documents in containing message are probably being processed).
      ProcessingDocument
      in a component instance, being processed
      Queued
      on a queue
      Queuing
      in the process of being queued

    • Method Summary

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

      • MessageIsBeingProcessed

        public static final DocumentState.Status MessageIsBeingProcessed
        in a component instance, but not being processed currently (other documents in containing message are probably being processed).

      • ProcessingDocument

        public static final DocumentState.Status ProcessingDocument
        in a component instance, being processed

      • InitialState

        public static final DocumentState.Status InitialState
        state is essentially unknown, generally should not occur

    • Method Detail

      • values

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

      • valueOf

        public static DocumentState.Status 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