Package org.kinotic.continuum.grind.api

Enum Class ResultType

java.lang.Object

java.lang.Enum<ResultType>

org.kinotic.continuum.grind.api.ResultType

All Implemented Interfaces:

Serializable, Comparable<ResultType>, Constable

public enum ResultType
extends Enum<ResultType>

Created by Navid Mitchell on 11/11/20

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

Modifier and Type	Method	Description
static ResultType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResultType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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

PROGRESS

public static final ResultType PROGRESS

The result value is a Progress object

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 Details

values

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