com.algorithmia.algo.AlgoResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algorithmia-android Show documentation
algorithmia-android
The newest version!
package com.algorithmia.algo;

import com.algorithmia.AlgorithmException;
import com.algorithmia.TypeToken;

import java.lang.reflect.Type;

/**
 * A generic result, can be either AlgoSuccess or AlgoFailure
 */
public abstract class AlgoResponse {

    public abstract boolean isSuccess();
    public abstract boolean isFailure();

    public abstract Metadata getMetadata() throws AlgorithmException;

    /**
     * Convert the result to a specific class
     * @param  the type that the response will be deserialized into
     * @param returnClass the class used by the deserializer (should correspond with T)
     * @return the result, if this is AlgoSuccess
     * @throws AlgorithmException the error, if this is AlgoFailure
     */
    protected abstract  T as(Class returnClass) throws AlgorithmException;

    /**
     * Convert the result to a specific type
     * @param  the type that the response will be deserialized into
     * @param returnType the type used by the deserializer (should correspond with T)
     * @return the result, if this is AlgoSuccess
     * @throws AlgorithmException the error, if this is AlgoFailure
     */
    protected abstract  T as(Type returnType) throws AlgorithmException;


    /**
     * Convert the result to a specific type.
     * To avoid type erasure, be sure to instantiate as an anonymous class:
     *      * {@code new TypeToken(){} }
     * 
     * @param  the type that the response will be deserialized into
     * @param typeToken the type used by the deserializer (should correspond with T)
     * @return the result, if this is AlgoSuccess
     * @throws AlgorithmException the error, if this is AlgoFailure
     */
    public  T as(@SuppressWarnings("rawtypes") TypeToken typeToken) throws AlgorithmException {
        return this.as(typeToken.getType());
    }

    /**
     * Return JSON representation of the result.
     * @return the result, if this is AlgoSuccess
     * @throws AlgorithmException the error, if this is AlgoFailure
     */
    public abstract String asJsonString() throws AlgorithmException;

    /**
     * Return String representation of the result.
     * @return the result, if this is AlgoSuccess
     * @throws AlgorithmException the error, if this is AlgoFailure
     */
    public abstract String asString() throws AlgorithmException;

    /**
     * Return the raw output of the algorithm if it was called with AlgorithmOutputType.RAW
     * This is the only valid way to retrieve a result from a RAW request.  Will return null
     * for any other AlgorithmOutputType
     * @return the result, if this is AlgoSuccess
     * @throws AlgorithmException the error, if this is AlgoFailure
     */
    public abstract String getRawOutput() throws AlgorithmException;
}