io.buybrain.util

Class Result<T,E extends Throwable>

java.lang.Object

io.buybrain.util.Result<T,E>

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

Type that can be used to encode the result of a function, which can succeed or fail. Similar to Optional, but with an error object added for failure cases. Can conveniently deal with throwing functions without try-catch messes.

Method Summary

Modifier and Type	Method and Description
<R> Result<R,?>	andThen(ThrowingConsumer<T> op)
<R> Result<R,?>	andThen(ThrowingRunnable op)
<R> Result<R,?>	andThen(ThrowingSupplier<Result<R,?>> op)
Result<?,?>	andThenTry(ThrowingConsumer<T> op)
<R> Result<R,?>	andThenTry(ThrowingRunnable op)
<R> Result<R,?>	andThenTry(ThrowingSupplier<R> op)
static <T,E extends Throwable> Result<T,E>	err(E error)
T	get()
E	getError()
boolean	isOk()
<R> Result<R,?>	map(ThrowingFunction<T,Result<R,?>> op)
Result<T,?>	mapErr(ThrowingFunction<E,Result<T,?>> op)
static <T> Result<T,?>	ok()
static <T> Result<T,?>	ok(T value)
Result<T,?>	orElse(T defaultValue)
Result<T,?>	orElse(ThrowingConsumer<E> op)
Result<T,?>	orElse(ThrowingRunnable op)
Result<T,?>	orElse(ThrowingSupplier<Result<T,?>> op)
Result<T,?>	orElseTry(ThrowingConsumer<E> op)
Result<T,?>	orElseTry(ThrowingRunnable op)
Result<T,?>	orElseTry(ThrowingSupplier<T> op)
static <T> Result<T,?>	trying(ThrowingRunnable op)
static <T> Result<T,?>	trying(ThrowingSupplier<T> op)
<R> Result<R,?>	tryMap(ThrowingFunction<T,R> op)
Result<T,?>	tryMapErr(ThrowingFunction<E,T> op)

Methods inherited from class java.lang.Object

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

Method Detail

map

public <R> Result<R,?> map(@NonNull
                           ThrowingFunction<T,Result<R,?>> op)

tryMap

public <R> Result<R,?> tryMap(@NonNull
                              ThrowingFunction<T,R> op)

andThen

public <R> Result<R,?> andThen(@NonNull
                               ThrowingSupplier<Result<R,?>> op)

andThenTry

public <R> Result<R,?> andThenTry(@NonNull
                                  ThrowingSupplier<R> op)

andThen

public <R> Result<R,?> andThen(@NonNull
                               ThrowingConsumer<T> op)

andThenTry

public Result<?,?> andThenTry(@NonNull
                              ThrowingConsumer<T> op)

andThen

public <R> Result<R,?> andThen(@NonNull
                               ThrowingRunnable op)

andThenTry

public <R> Result<R,?> andThenTry(@NonNull
                                  ThrowingRunnable op)

orElse

public Result<T,?> orElse(T defaultValue)

mapErr

public Result<T,?> mapErr(@NonNull
                          ThrowingFunction<E,Result<T,?>> op)

tryMapErr

public Result<T,?> tryMapErr(@NonNull
                             ThrowingFunction<E,T> op)

orElse

public Result<T,?> orElse(@NonNull
                          ThrowingSupplier<Result<T,?>> op)

orElseTry

public Result<T,?> orElseTry(@NonNull
                             ThrowingSupplier<T> op)

orElse

public Result<T,?> orElse(@NonNull
                          ThrowingConsumer<E> op)

orElseTry

public Result<T,?> orElseTry(@NonNull
                             ThrowingConsumer<E> op)

orElse

public Result<T,?> orElse(@NonNull
                          ThrowingRunnable op)

orElseTry

public Result<T,?> orElseTry(@NonNull
                             ThrowingRunnable op)

get

public T get()
      throws E extends Throwable

Throws:

E extends Throwable

getError

public E getError()

ok

public static <T> Result<T,?> ok()

trying

public static <T> Result<T,?> trying(@NonNull
                                     ThrowingSupplier<T> op)

trying

public static <T> Result<T,?> trying(@NonNull
                                     ThrowingRunnable op)

isOk

public boolean isOk()

ok

public static <T> Result<T,?> ok(T value)

err

public static <T,E extends Throwable> Result<T,E> err(@NonNull
                                                      E error)