oak.util

Class Result<T,E extends Exception>

java.lang.Object

oak.util.Result<T,E>

public class Result<T,E extends Exception>
extends Object

This class represents either a valid result or an exception. This is useful for asynchronous calls where the exception cannot be thrown immediately.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Result(E error)
protected	Result(T result)

Method Summary

Modifier and Type	Method and Description
static <T,E extends Exception> Result<T,E>	error(E error) Constructs an unsuccessful result.
T	get() Returns the value if successful, throws the error is not.
E	getError() Returns the error if unsuccessful.
T	getSuccess() Returns the value if successful.
boolean	isError() Returns if the result is an error
boolean	isSuccess() Returns if the result is successful
static <T,E extends Exception> Result<T,E>	success(T value) Constructs a successful result.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

protected Result(T result)

Result

protected Result(E error)

Method Detail

success

public static <T,E extends Exception> Result<T,E> success(T value)

Constructs a successful result.

Type Parameters:

T - the value type

E - the error type

Parameters:

value - the successful value

Returns:

the result

error

public static <T,E extends Exception> Result<T,E> error(E error)

Constructs an unsuccessful result.

Type Parameters:

T - the value type

E - the error type

Parameters:

error - the error

Returns:

the result

isSuccess

public boolean isSuccess()

Returns if the result is successful

Returns:

true if successful, false otherwise

isError

public boolean isError()

Returns if the result is an error

Returns:

true if error, false otherwise

get

public T get()
      throws E extends Exception

Returns the value if successful, throws the error is not.

Returns:

the value if successful

Throws:

E - the error if not

E extends Exception

getSuccess

public T getSuccess()

Returns the value if successful. Use @{link Result#isSuccess} to first check if the result is successful.

Returns:

the value if successful

Throws:

IllegalStateException - thrown if the result was not successful

getError

public E getError()

Returns the error if unsuccessful. Use @{link Result#isError} to first check if the result is an error.

Returns:

the error if unsuccessful

Throws:

IllegalStateException - thrown if the result was not an error