Module io.annot8.api

Package io.annot8.api.components.responses

Interface ProcessorResponse

All Known Implementing Classes:

ProcessorResponse.ProcessorResponseBuilder

public interface ProcessorResponse

Class to hold the response from a processor.

The response consists of a status.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcessorResponse.ProcessorResponseBuilder
static class	ProcessorResponse.Status	Response status returned by the processor

Method Summary

Modifier and Type	Method	Description
Collection<Exception>	getExceptions()	Return any exceptions associated with this response
ProcessorResponse.Status	getStatus()	Return the status associated with this response
default boolean	hasExceptions()	Are exceptions associated with response?
static ProcessorResponse.ProcessorResponseBuilder	itemError()	Create an ITEM_ERROR response
static ProcessorResponse.ProcessorResponseBuilder	itemError(Exception... exceptions)	Create an ITEM_ERROR response with one or more exception
static ProcessorResponse.ProcessorResponseBuilder	itemError(Collection<Exception> exceptions)	Create an ITEM_ERROR response with a collection of exceptions
static ProcessorResponse.ProcessorResponseBuilder	ok()	Create an OK response with no new items
static ProcessorResponse.ProcessorResponseBuilder	processingError()	Create a PROCESSOR_ERROR response
static ProcessorResponse.ProcessorResponseBuilder	processingError(Exception... exceptions)	Create an PROCESSOR_ERROR response with one or more exception
static ProcessorResponse.ProcessorResponseBuilder	processingError(Collection<Exception> exceptions)	Create an PROCESSOR_ERROR response with a collection of exceptions

Method Detail

ok

static ProcessorResponse.ProcessorResponseBuilder ok()

Create an OK response with no new items

Returns:

builder for continuation

itemError

static ProcessorResponse.ProcessorResponseBuilder itemError()

Create an ITEM_ERROR response

Returns:

builder for continuation

itemError

static ProcessorResponse.ProcessorResponseBuilder itemError(Collection<Exception> exceptions)

Create an ITEM_ERROR response with a collection of exceptions

Parameters:

exceptions - exceptions for information

Returns:

builder for continuation

itemError

static ProcessorResponse.ProcessorResponseBuilder itemError(Exception... exceptions)

Create an ITEM_ERROR response with one or more exception

Parameters:

exceptions - exception for information

Returns:

builder for continuation

processingError

static ProcessorResponse.ProcessorResponseBuilder processingError()

Create a PROCESSOR_ERROR response

Returns:

builder for continuation

processingError

static ProcessorResponse.ProcessorResponseBuilder processingError(Collection<Exception> exceptions)

Create an PROCESSOR_ERROR response with a collection of exceptions

Parameters:

exceptions - exception for information

Returns:

builder for continuation

processingError

static ProcessorResponse.ProcessorResponseBuilder processingError(Exception... exceptions)

Create an PROCESSOR_ERROR response with one or more exception

Parameters:

exceptions - exceptions for information

Returns:

builder for continuation

getStatus

ProcessorResponse.Status getStatus()

Return the status associated with this response

Returns:

status

getExceptions

Collection<Exception> getExceptions()

Return any exceptions associated with this response

Returns:

exceptions thrown during processing

hasExceptions

default boolean hasExceptions()

Are exceptions associated with response?

Returns:

true is exceptions are part of the response