Package gov.nasa.jpl.aerie.merlin.framework

Class Result<Success,Failure>

java.lang.Object

gov.nasa.jpl.aerie.merlin.framework.Result<Success,Failure>

Type Parameters:

Success - The type of the success variant of the Result.

Failure - The type of the failure variant of the Result.

public abstract class Result<Success,Failure>
extends Object

This class is the equivalent of the type `Result L R = Success L | Failure R` in a language with algebraic data types, but adapted to the vagaries of the Java platform. The sum alternatives are represented as a closed family of classes implementing a common interface. Case evaluation is represented by the visitor pattern.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Result.Kind
static interface	Result.Visitor<Success,Failure,Output,Throws extends Throwable>
static interface	Result.VisitorCase<Input,Output,Throws extends Throwable>

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static <Success, Failure> Result<Success,Failure>	failure(Failure value)	Factory method for the Right variant.
Failure	getFailureOrThrow()
<Throws extends Throwable> Failure	getFailureOrThrow(Function<Success,Throws> factory)
Result.Kind	getKind()
Success	getSuccessOrThrow()
<Throws extends Throwable> Success	getSuccessOrThrow(Function<Failure,Throws> factory)
int	hashCode()
<OutputSuccess, OutputFailure, Throws extends Throwable> Result<OutputSuccess,OutputFailure>	map(Result.VisitorCase<Success,OutputSuccess,Throws> onSuccess, Result.VisitorCase<Failure,OutputFailure,Throws> onFailure)
<Output, Throws extends Throwable> Result<Success,Output>	mapFailure(Result.VisitorCase<Failure,Output,Throws> onFailure)
<Output, Throws extends Throwable> Result<Output,Failure>	mapSuccess(Result.VisitorCase<Success,Output,Throws> onSuccess)
abstract <Output, Throws extends Throwable> Output	match(Result.Visitor<Success,Failure,Output,Throws> visitor)
<Output, Throws extends Throwable> Output	match(Result.VisitorCase<Success,Output,Throws> onSuccess, Result.VisitorCase<Failure,Output,Throws> onFailure)	Convenience method for matching in a way syntactically similar to switch statements.
static <Success, Failure> Result<Success,Failure>	success(Success value)	Factory method for the Left variant.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

match

public abstract <Output,
Throws extends Throwable>
Output match(Result.Visitor<Success,Failure,Output,Throws> visitor)
      throws Throws

Throws:

Throws

success

public static <Success,
Failure>
Result<Success,Failure> success(Success value)

Factory method for the Left variant.

failure

public static <Success,
Failure>
Result<Success,Failure> failure(Failure value)

Factory method for the Right variant.

match

public <Output,
Throws extends Throwable> Output match(Result.VisitorCase<Success,Output,Throws> onSuccess,
 Result.VisitorCase<Failure,Output,Throws> onFailure)
                                                throws Throws

Convenience method for matching in a way syntactically similar to switch statements.

Throws:

Throws

map

public <OutputSuccess,
OutputFailure,
Throws extends Throwable>
Result<OutputSuccess,OutputFailure> map(Result.VisitorCase<Success,OutputSuccess,Throws> onSuccess,
 Result.VisitorCase<Failure,OutputFailure,Throws> onFailure)
                                 throws Throws

Throws:

Throws

mapSuccess

public <Output,
Throws extends Throwable>
Result<Output,Failure> mapSuccess(Result.VisitorCase<Success,Output,Throws> onSuccess)
                           throws Throws

Throws:

Throws

mapFailure

public <Output,
Throws extends Throwable>
Result<Success,Output> mapFailure(Result.VisitorCase<Failure,Output,Throws> onFailure)
                           throws Throws

Throws:

Throws

getSuccessOrThrow

public <Throws extends Throwable> Success getSuccessOrThrow(Function<Failure,Throws> factory)
                                                     throws Throws

Throws:

Throws

getFailureOrThrow

public <Throws extends Throwable> Failure getFailureOrThrow(Function<Success,Throws> factory)
                                                     throws Throws

Throws:

Throws

getSuccessOrThrow

public Success getSuccessOrThrow()

getFailureOrThrow

public Failure getFailureOrThrow()

getKind

public Result.Kind getKind()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object