Package org.kinotic.continuum.grind.api

Enum ResultType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ResultType>
    public enum ResultType
extends java.lang.Enum<ResultType>
    Created by Navid Mitchell on 11/11/20

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DIAGNOSTIC
      The result value is a Diagnostic message
      DYNAMIC_STEPS
      Result contains new Step's that have been returned by a Task execution This is used to update the known Step's when wanting to receive progress notifications The result value will contain the new Step
      EXCEPTION
      The result value is a Throwable indicating that an error occurred at the given step
      NOOP
      The task resulted in no action being taken the value will be null
      PROGRESS
      The result value is a Progress object
      VALUE
      The result value is the final VALUE of the task

    • Method Summary

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

      • VALUE

        public static final ResultType VALUE
        The result value is the final VALUE of the task

      • NOOP

        public static final ResultType NOOP
        The task resulted in no action being taken the value will be null

      • DIAGNOSTIC

        public static final ResultType DIAGNOSTIC
        The result value is a Diagnostic message

      • DYNAMIC_STEPS

        public static final ResultType DYNAMIC_STEPS
        Result contains new Step's that have been returned by a Task execution This is used to update the known Step's when wanting to receive progress notifications The result value will contain the new Step

      • EXCEPTION

        public static final ResultType EXCEPTION
        The result value is a Throwable indicating that an error occurred at the given step

    • Method Detail

      • values

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

      • valueOf

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