org.gbif.common.parsers.core

Class ParseResult<T>

java.lang.Object

org.gbif.common.parsers.core.ParseResult<T>

Direct Known Subclasses:

OccurrenceParseResult

public class ParseResult<T>
extends Object

This represents the response of a generic parse operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParseResult.CONFIDENCE
static class	ParseResult.STATUS

Constructor Summary

Constructors

Constructor and Description
ParseResult(ParseResult.STATUS status, ParseResult.CONFIDENCE confidence, T payload, List<T> alternativePayloads, Throwable error) Forces all fields to be provided

Method Summary

Modifier and Type	Method and Description
static <T1> ParseResult<T1>	error()
static <T1> ParseResult<T1>	error(Throwable cause)
static <T1> ParseResult<T1>	fail()
List<T>	getAlternativePayloads()
ParseResult.CONFIDENCE	getConfidence()
Throwable	getError()
T	getPayload()
ParseResult.STATUS	getStatus()
boolean	isSuccessful() Returns true if getStatus() returns SUCCESS.
static <T1> ParseResult<T1>	success(ParseResult.CONFIDENCE confidence, T1 payload)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParseResult

public ParseResult(ParseResult.STATUS status,
                   ParseResult.CONFIDENCE confidence,
                   T payload,
                   List<T> alternativePayloads,
                   Throwable error)

Forces all fields to be provided

Parameters:

status - The status of the response

confidence - The confidence in the result

payload - The payload of the response

error - The error in the response

Method Detail

success

public static <T1> ParseResult<T1> success(ParseResult.CONFIDENCE confidence,
                                           T1 payload)

Type Parameters:

T1 - The generic type of the payload

Parameters:

confidence - The confidence in the result

payload - The payload of the parse result

Returns:

The new ParseResult which has no error and status of SUCCESS

fail

public static <T1> ParseResult<T1> fail()

Returns:

A new parse response with only the status set to FAIL

error

public static <T1> ParseResult<T1> error()

Returns:

A new parse response configured to indicate an error

error

public static <T1> ParseResult<T1> error(Throwable cause)

Parameters:

cause - The cause of the error

Returns:

A new parse response configured with error and the cause

getStatus

public ParseResult.STATUS getStatus()

getConfidence

public ParseResult.CONFIDENCE getConfidence()

getPayload

public T getPayload()

getAlternativePayloads

public List<T> getAlternativePayloads()

getError

public Throwable getError()

isSuccessful

public boolean isSuccessful()

Returns true if getStatus() returns SUCCESS.

Returns:

true if the parse operation was successful.

toString

public String toString()

Overrides:

toString in class Object