Package com.globalmentor.model

Enum TaskState

  • All Implemented Interfaces:
    Identifier, Token, java.io.Serializable, java.lang.Comparable<TaskState>
    public enum TaskState
extends java.lang.Enum<TaskState>
implements Identifier
    Represents the progress of a task.
    Author:
    Garret Wilson

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CANCELED
      The task has been abandoned.
      COMPLETE
      The task has been completed.
      ERROR
      The task has been started but there is an error.
      INCOMPLETE
      The task has been started but is incomplete.
      INITIALIZE
      The task is preparing to begin.
      PAUSED
      The task is temporarily paused.
      STOPPED
      The task is stopped.
      UNSTARTED
      The task has not yet begun.

    • Method Summary

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

      • UNSTARTED

        public static final TaskState UNSTARTED
        The task has not yet begun.

      • INITIALIZE

        public static final TaskState INITIALIZE
        The task is preparing to begin.

      • INCOMPLETE

        public static final TaskState INCOMPLETE
        The task has been started but is incomplete.

      • ERROR

        public static final TaskState ERROR
        The task has been started but there is an error.

      • PAUSED

        public static final TaskState PAUSED
        The task is temporarily paused.

      • STOPPED

        public static final TaskState STOPPED
        The task is stopped.

      • CANCELED

        public static final TaskState CANCELED
        The task has been abandoned.

      • COMPLETE

        public static final TaskState COMPLETE
        The task has been completed.

    • Method Detail

      • values

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

      • valueOf

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