Module io.annot8.api

Package io.annot8.api.components.responses

Enum ProcessorResponse.Status

java.lang.Object

java.lang.Enum<ProcessorResponse.Status>

io.annot8.api.components.responses.ProcessorResponse.Status

All Implemented Interfaces:

Serializable, Comparable<ProcessorResponse.Status>

Enclosing interface:

ProcessorResponse

public static enum ProcessorResponse.Status
extends Enum<ProcessorResponse.Status>

Response status returned by the processor

Enum Constant Summary

Enum Constants

Enum Constant	Description
ITEM_ERROR	Indicates that an error happened whilst processing this item, but that it should be possible to process other items.
OK	Indicates that the processor has worked successfully
PROCESSOR_ERROR	Indicates that an error happened whilst processing this item, and that it will prevent other items from being processed.

Method Summary

Modifier and Type	Method	Description
static ProcessorResponse.Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProcessorResponse.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

OK

public static final ProcessorResponse.Status OK

Indicates that the processor has worked successfully

ITEM_ERROR

public static final ProcessorResponse.Status ITEM_ERROR

Indicates that an error happened whilst processing this item, but that it should be possible to process other items.

PROCESSOR_ERROR

public static final ProcessorResponse.Status PROCESSOR_ERROR

Indicates that an error happened whilst processing this item, and that it will prevent other items from being processed.

Method Detail

values

public static ProcessorResponse.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 (ProcessorResponse.Status c : ProcessorResponse.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 ProcessorResponse.Status valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null