Module io.annot8.api

Package io.annot8.api.components.responses

Interface SourceResponse

All Known Implementing Classes:

SourceResponse.SourceResponseBuilder

public interface SourceResponse

Class to hold the response from a source.

The response consists of a status.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SourceResponse.SourceResponseBuilder
static class	SourceResponse.Status	Response status returned by the source

Method Summary

Modifier and Type	Method	Description
static SourceResponse.SourceResponseBuilder	done()	Source is now out of items
static SourceResponse.SourceResponseBuilder	empty()	The Source is currently empty
Collection<Exception>	getExceptions()	Return any exceptions associated with this response
SourceResponse.Status	getStatus()	Return the status associated with this response
default boolean	hasExceptions()	Does this response has exceptions associated with it?
static SourceResponse.SourceResponseBuilder	ok()	Create source read items normally
static SourceResponse.SourceResponseBuilder	sourceError()	There was an error reading from the Source
static SourceResponse.SourceResponseBuilder	sourceError(Exception... exceptions)	There was an error reading from the Source with one or more exception
static SourceResponse.SourceResponseBuilder	sourceError(Collection<Exception> exceptions)	There was an error reading from the Source with a collection of exceptions

Method Detail

ok

static SourceResponse.SourceResponseBuilder ok()

Create source read items normally

Returns:

builder for continuation

done

static SourceResponse.SourceResponseBuilder done()

Source is now out of items

Returns:

builder for continuation

sourceError

static SourceResponse.SourceResponseBuilder sourceError()

There was an error reading from the Source

Returns:

builder for continuation

sourceError

static SourceResponse.SourceResponseBuilder sourceError(Collection<Exception> exceptions)

There was an error reading from the Source with a collection of exceptions

Parameters:

exceptions - exception for information

Returns:

builder for continuation

sourceError

static SourceResponse.SourceResponseBuilder sourceError(Exception... exceptions)

There was an error reading from the Source with one or more exception

Parameters:

exceptions - exception for information

Returns:

builder for continuation

empty

static SourceResponse.SourceResponseBuilder empty()

The Source is currently empty

Returns:

builder for continuation

getStatus

SourceResponse.Status getStatus()

Return the status associated with this response

Returns:

status

getExceptions

Collection<Exception> getExceptions()

Return any exceptions associated with this response

Returns:

list of exceptions during read

hasExceptions

default boolean hasExceptions()

Does this response has exceptions associated with it?

Returns:

true is has exceptions