com.leakyabstractions.result.core

Class Results

java.lang.Object

com.leakyabstractions.result.core.Results

public class Results
extends Object

This class consists exclusively of static methods that operate on or return Result instances.

Author:

Guillermo Calvo

See Also:

com.leakyabstractions.result

Method Summary

Modifier and Type	Method and Description
static <S,F> Result<S,F>	failure(F failure) Creates a new failed result with a given value.
static <S> Result<S,Exception>	ofCallable(Callable<? extends S> callable) If the given callable produces a success value, returns a new successful result with it; otherwise returns a new failed result with the exception thrown by callable.
static <S,F> Result<S,F>	ofNullable(S value, F failure) If the given value is not null, returns a new successful result with it; otherwise returns a new failed result with failure.
static <S,F> Result<S,F>	ofNullable(S value, Supplier<? extends F> failureSupplier) If the given value is not null, returns a new successful result with it; otherwise returns a new failed result with a value produced by the given supplier function.
static <S,F> Result<S,F>	ofOptional(Optional<S> optional, F failure) If the given optional is not empty, returns a new successful result with its value; otherwise returns a new failed result with failure.
static <S,F> Result<S,F>	ofOptional(Optional<S> optional, Supplier<? extends F> failureSupplier) If the given optional is not empty, returns a new successful result with its value; otherwise returns a new failed result with a value produced by the given supplier function.
static <S,F> Result<S,F>	success(S success) Creates a new successful result with a given value.

Methods inherited from class java.lang.Object

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

Method Detail

success

public static <S,F> Result<S,F> success(S success)

Creates a new successful result with a given value.

Type Parameters:

S - the success type of the result

F - the failure type of the result

Parameters:

success - the success value

Returns:

the new successful result

Throws:

NullPointerException - if success is null

failure

public static <S,F> Result<S,F> failure(F failure)

Creates a new failed result with a given value.

Type Parameters:

S - the success type of the result

F - the failure type of the result

Parameters:

failure - the failure value

Returns:

the new failed result

Throws:

NullPointerException - if failure is null

ofNullable

public static <S,F> Result<S,F> ofNullable(S value,
                                           F failure)

If the given value is not null, returns a new successful result with it; otherwise returns a new failed result with failure.

Type Parameters:

S - the success type of the result

F - the failure type of the result

Parameters:

value - the value to check if null

failure - the failure value to use in case value is null

Returns:

the new result

Throws:

NullPointerException - if both value and failure are null

ofNullable

public static <S,F> Result<S,F> ofNullable(S value,
                                           Supplier<? extends F> failureSupplier)

If the given value is not null, returns a new successful result with it; otherwise returns a new failed result with a value produced by the given supplier function.

Type Parameters:

S - the success type of the result

F - the failure type of the result

Parameters:

value - the value to check if null

failureSupplier - the supplier function that produces a failure value

Returns:

the new result

Throws:

NullPointerException - if both value and failureSupplier are null, or if failureSupplier returns null

ofOptional

public static <S,F> Result<S,F> ofOptional(Optional<S> optional,
                                           F failure)

If the given optional is not empty, returns a new successful result with its value; otherwise returns a new failed result with failure.

Type Parameters:

S - the success type of the result

F - the failure type of the result

Parameters:

optional - the optional to check if empty

failure - the failure value to use in case optional is empty

Returns:

the new result

Throws:

NullPointerException - if optional is null; or if optional is empty and failure is null

ofOptional

public static <S,F> Result<S,F> ofOptional(Optional<S> optional,
                                           Supplier<? extends F> failureSupplier)

If the given optional is not empty, returns a new successful result with its value; otherwise returns a new failed result with a value produced by the given supplier function.

Type Parameters:

S - the success type of the result

F - the failure type of the result

Parameters:

optional - the optional to check if empty

failureSupplier - the supplier function that produces a failure value

Returns:

the new result

Throws:

NullPointerException - if optional is null; or if optional is empty and failureSupplier is null; or if failureSupplier returns null

ofCallable

public static <S> Result<S,Exception> ofCallable(Callable<? extends S> callable)

If the given callable produces a success value, returns a new successful result with it; otherwise returns a new failed result with the exception thrown by callable.

Type Parameters:

S - the success type of the result

Parameters:

callable - the task that produces a success value, or throws an exception if unable to do so

Returns:

the new result

Throws:

NullPointerException - if callable is null; or if callable returns null