com.algorithmia.algo

Class AlgoResponse

java.lang.Object

com.algorithmia.algo.AlgoResponse

Direct Known Subclasses:

AlgoFailure, AlgoSuccess

public abstract class AlgoResponse
extends java.lang.Object

A generic result, can be either AlgoSuccess or AlgoFailure

Constructor Summary

Constructors

Constructor and Description
AlgoResponse()

Method Summary

Modifier and Type	Method and Description
protected abstract <T> T	as(java.lang.Class<T> returnClass) Convert the result to a specific class
protected abstract <T> T	as(java.lang.reflect.Type returnType) Convert the result to a specific type
<T> T	as(TypeToken typeToken) Convert the result to a specific type.
abstract Metadata	getMetadata()
abstract boolean	isFailure()
abstract boolean	isSuccess()
java.lang.String	toString() Get string representation of the result or throw an exception

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AlgoResponse

public AlgoResponse()

Method Detail

isSuccess

public abstract boolean isSuccess()

isFailure

public abstract boolean isFailure()

getMetadata

public abstract Metadata getMetadata()
                              throws AlgorithmException

Throws:

AlgorithmException

as

protected abstract <T> T as(java.lang.Class<T> returnClass)
                     throws AlgorithmException

Convert the result to a specific class

Type Parameters:

T - the type that the response will be deserialized into

Parameters:

returnClass - the class used by the deserializer (should correspond with T)

Returns:

the result, if this is AlgoSuccess

Throws:

AlgorithmException - the error, if this is AlgoFailure

as

protected abstract <T> T as(java.lang.reflect.Type returnType)
                     throws AlgorithmException

Convert the result to a specific type

Type Parameters:

T - the type that the response will be deserialized into

Parameters:

returnType - the type used by the deserializer (should correspond with T)

Returns:

the result, if this is AlgoSuccess

Throws:

AlgorithmException - the error, if this is AlgoFailure

as

public <T> T as(TypeToken typeToken)
         throws AlgorithmException

Convert the result to a specific type. To avoid type erasure, be sure to instantiate as an anonymous class:

  new TypeToken<MyClass>(){} 
 

Type Parameters:

T - the type that the response will be deserialized into

Parameters:

typeToken - the type used by the deserializer (should correspond with T)

Returns:

the result, if this is AlgoSuccess

Throws:

AlgorithmException - the error, if this is AlgoFailure

toString

public java.lang.String toString()

Get string representation of the result or throw an exception

Overrides:

toString in class java.lang.Object

Returns:

the result as a UTF-8 string if this is AlgoSuccess, otherwise null