Package panda.std

Class Result<VALUE,ERROR>

java.lang.Object

panda.std.Result<VALUE,ERROR>

Type Parameters:

VALUE - type of value

ERROR - type of error

public class Result<VALUE,ERROR>
extends Object

Result represents value or associated error that caused the absence of the expected value. By definition, Result has to contain one non-null value - the value or the error. If you want to use nullable value or nullable error, you have to use wrapper like Option to explicitly declare it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Result.FilteredResult<VALUE,FILTER_ERROR,EXPECTED_ERROR>
static enum	Result.State

Method Summary

Modifier and Type	Method	Description
static <VALUE, ERROR extends Throwable> @NotNull Result<VALUE,ERROR>	attempt(@NotNull Class<? extends ERROR> exceptionType, @NotNull ThrowingSupplier<VALUE,@NotNull ERROR> supplier)	Deprecated.
static <VALUE> @NotNull Result<VALUE,Exception>	attempt(@NotNull ThrowingSupplier<VALUE,@NotNull Exception> supplier)	Deprecated.
Result<VALUE,ERROR>	consume(@NotNull Consumer<VALUE> valueConsumer, @NotNull Consumer<ERROR> errorConsumer)
boolean	equals(Object to)
static <VALUE> @NotNull Result<VALUE,Blank>	error()
static <VALUE, ERROR> @NotNull Result<VALUE,ERROR>	error(ERROR err)
@NotNull Option<@NotNull ERROR>	errorToOption()
@NotNull Result<VALUE,ERROR>	filter(@NotNull Function<VALUE,@Nullable ERROR> filtersBody)
@NotNull Result<VALUE,ERROR>	filter(@NotNull Predicate<VALUE> predicate, @NotNull Function<VALUE,ERROR> errorSupplier)
@NotNull Result<VALUE,ERROR>	filterNot(@NotNull Predicate<VALUE> predicate, @NotNull Function<VALUE,ERROR> errorSupplier)
<E extends Exception> @NotNull Result.FilteredResult<VALUE,E,ERROR>	filterWithThrowing(@NotNull ThrowingConsumer<VALUE,@NotNull E> filtersBody)
<MAPPED_VALUE> @NotNull Result<MAPPED_VALUE,ERROR>	flatMap(@NotNull Function<VALUE,@NotNull Result<MAPPED_VALUE,? extends ERROR>> function)
<MAPPED_ERROR> @NotNull Result<VALUE,MAPPED_ERROR>	flatMapErr(@NotNull Function<@NotNull ERROR,@NotNull Result<VALUE,MAPPED_ERROR>> function)
<COMMON> COMMON	fold(@NotNull Function<VALUE,COMMON> valueMerge, @NotNull Function<ERROR,COMMON> errorMerge)
VALUE	get()
Object	getAny()
<AS> AS	getAnyAs()
ERROR	getError()
Result.State	getState()
int	hashCode()
<MAPPED_VALUE> @NotNull Result<MAPPED_VALUE,ERROR>	is(@NotNull Class<MAPPED_VALUE> type, @NotNull Function<VALUE,ERROR> errorSupplier)
boolean	isErr()
boolean	isOk()
<MAPPED_VALUE> @NotNull Result<MAPPED_VALUE,ERROR>	map(@NotNull Function<VALUE,MAPPED_VALUE> function)
<MAPPED_ERROR> @NotNull Result<VALUE,MAPPED_ERROR>	mapErr(@NotNull Function<ERROR,MAPPED_ERROR> function)
@NotNull Result<VALUE,Blank>	mapErrToBlank()
@NotNull Result<Blank,ERROR>	mapToBlank()
boolean	matches(Predicate<VALUE> condition)
<SECOND_VALUE, R> @NotNull Result<R,ERROR>	merge(@NotNull Result<SECOND_VALUE,? extends ERROR> second, @NotNull BiFunction<VALUE,SECOND_VALUE,R> mergeFunction)
static <ERROR> @NotNull Result<Blank,ERROR>	ok()
static <VALUE, ERROR> @NotNull Result<VALUE,ERROR>	ok(VALUE value)
@NotNull Result<VALUE,ERROR>	onError(@NotNull Consumer<ERROR> consumer)
@NotNull Result<VALUE,ERROR>	orElse(@NotNull Function<ERROR,@NotNull Result<VALUE,ERROR>> orElse)
VALUE	orElseGet(@NotNull Function<ERROR,VALUE> orElse)
<E extends Exception> VALUE	orElseThrow(@NotNull ThrowingFunction<ERROR,E,E> consumer)	Deprecated.
VALUE	orNull()
<E extends Exception> VALUE	orThrow(@NotNull ThrowingFunction<ERROR,E,E> consumer)
@NotNull Result<VALUE,ERROR>	peek(@NotNull Consumer<VALUE> consumer)
<REQUIRED_VALUE, REQUIRED_ERROR> @NotNull Result<REQUIRED_VALUE,REQUIRED_ERROR>	project()
<REQUIRED_VALUE> @NotNull Result<REQUIRED_VALUE,ERROR>	projectToError()
<REQUIRED_ERROR> @NotNull Result<VALUE,REQUIRED_ERROR>	projectToValue()
static <ERROR extends Throwable> @NotNull Result<Void,ERROR>	runThrowing(@NotNull Class<? extends ERROR> exceptionType, @NotNull ThrowingRunnable<@NotNull ERROR> runnable)
static <ERROR extends Exception> @NotNull Result<Void,@NotNull Exception>	runThrowing(@NotNull ThrowingRunnable<@NotNull Exception> runnable)
static <VALUE, ERROR extends Throwable> @NotNull Result<VALUE,ERROR>	supplyThrowing(@NotNull Class<? extends ERROR> exceptionType, @NotNull ThrowingSupplier<VALUE,@NotNull ERROR> supplier)
static <VALUE> @NotNull Result<VALUE,Exception>	supplyThrowing(@NotNull ThrowingSupplier<VALUE,@NotNull Exception> supplier)
@NotNull Result<ERROR,VALUE>	swap()
@NotNull Option<@NotNull VALUE>	toOption()
String	toString()
static <VALUE, ERROR> @NotNull Result<VALUE,ERROR>	when(boolean condition, @NotNull Supplier<VALUE> value, @NotNull Supplier<ERROR> err)
static <VALUE, ERROR> @NotNull Result<VALUE,ERROR>	when(boolean condition, VALUE value, ERROR err)

Methods inherited from class java.lang.Object

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

Method Details

ok

@NotNull
public static <VALUE,
ERROR>
@NotNull Result<VALUE,ERROR> ok(VALUE value)

ok

@NotNull
public static <ERROR> @NotNull Result<Blank,ERROR> ok()

error

@NotNull
public static <VALUE,
ERROR>
@NotNull Result<VALUE,ERROR> error(ERROR err)

error

@NotNull
public static <VALUE> @NotNull Result<VALUE,Blank> error()

when

@NotNull
public static <VALUE,
ERROR>
@NotNull Result<VALUE,ERROR> when(boolean condition,
 @NotNull
 @NotNull Supplier<VALUE> value,
 @NotNull
 @NotNull Supplier<ERROR> err)

when

@NotNull
public static <VALUE,
ERROR>
@NotNull Result<VALUE,ERROR> when(boolean condition,
 VALUE value,
 ERROR err)

runThrowing

@NotNull
public static <ERROR extends Exception>
@NotNull Result<Void,@NotNull Exception> runThrowing(@NotNull
 @NotNull ThrowingRunnable<@NotNull Exception> runnable)
                                              throws AttemptFailedException

Throws:

AttemptFailedException

runThrowing

@NotNull
public static <ERROR extends Throwable>
@NotNull Result<Void,ERROR> runThrowing(@NotNull
 @NotNull Class<? extends ERROR> exceptionType,
 @NotNull
 @NotNull ThrowingRunnable<@NotNull ERROR> runnable)
                                 throws AttemptFailedException

Throws:

AttemptFailedException

attempt

@Deprecated
@NotNull
public static <VALUE>
@NotNull Result<VALUE,Exception> attempt(@NotNull
 @NotNull ThrowingSupplier<VALUE,@NotNull Exception> supplier)

Deprecated.

See Also:

• supplyThrowing(panda.std.function.ThrowingSupplier)

attempt

@Deprecated
@NotNull
public static <VALUE,
ERROR extends Throwable>
@NotNull Result<VALUE,ERROR> attempt(@NotNull
 @NotNull Class<? extends ERROR> exceptionType,
 @NotNull
 @NotNull ThrowingSupplier<VALUE,@NotNull ERROR> supplier)
                              throws AttemptFailedException

Deprecated.

Throws:

AttemptFailedException

See Also:

• supplyThrowing(Class, panda.std.function.ThrowingSupplier)

supplyThrowing

@NotNull
public static <VALUE>
@NotNull Result<VALUE,Exception> supplyThrowing(@NotNull
 @NotNull ThrowingSupplier<VALUE,@NotNull Exception> supplier)

supplyThrowing

@NotNull
public static <VALUE,
ERROR extends Throwable>
@NotNull Result<VALUE,ERROR> supplyThrowing(@NotNull
 @NotNull Class<? extends ERROR> exceptionType,
 @NotNull
 @NotNull ThrowingSupplier<VALUE,@NotNull ERROR> supplier)
                                     throws AttemptFailedException

Throws:

AttemptFailedException

merge

@NotNull
public <SECOND_VALUE,
R> @NotNull Result<R,ERROR> merge(@NotNull
 @NotNull Result<SECOND_VALUE,? extends ERROR> second,
 @NotNull
 @NotNull BiFunction<VALUE,SECOND_VALUE,R> mergeFunction)

map

@NotNull
public <MAPPED_VALUE>
@NotNull Result<MAPPED_VALUE,ERROR> map(@NotNull
 @NotNull Function<VALUE,MAPPED_VALUE> function)

mapToBlank

@NotNull
public @NotNull Result<Blank,ERROR> mapToBlank()

mapErrToBlank

@NotNull
public @NotNull Result<VALUE,Blank> mapErrToBlank()

mapErr

@NotNull
public <MAPPED_ERROR>
@NotNull Result<VALUE,MAPPED_ERROR> mapErr(@NotNull
 @NotNull Function<ERROR,MAPPED_ERROR> function)

flatMap

@NotNull
public <MAPPED_VALUE>
@NotNull Result<MAPPED_VALUE,ERROR> flatMap(@NotNull
 @NotNull Function<VALUE,@NotNull Result<MAPPED_VALUE,? extends ERROR>> function)

flatMapErr

@NotNull
public <MAPPED_ERROR>
@NotNull Result<VALUE,MAPPED_ERROR> flatMapErr(@NotNull
 @NotNull Function<@NotNull ERROR,@NotNull Result<VALUE,MAPPED_ERROR>> function)

filter

@NotNull
public @NotNull Result<VALUE,ERROR> filter(@NotNull
 @NotNull Predicate<VALUE> predicate,
 @NotNull
 @NotNull Function<VALUE,ERROR> errorSupplier)

filterNot

@NotNull
public @NotNull Result<VALUE,ERROR> filterNot(@NotNull
 @NotNull Predicate<VALUE> predicate,
 @NotNull
 @NotNull Function<VALUE,ERROR> errorSupplier)

filter

@NotNull
public @NotNull Result<VALUE,ERROR> filter(@NotNull
 @NotNull Function<VALUE,@Nullable ERROR> filtersBody)

filterWithThrowing

@NotNull
public <E extends Exception>
@NotNull Result.FilteredResult<VALUE,E,ERROR> filterWithThrowing(@NotNull
 @NotNull ThrowingConsumer<VALUE,@NotNull E> filtersBody)

fold

public <COMMON> COMMON fold(@NotNull
 @NotNull Function<VALUE,COMMON> valueMerge,
 @NotNull
 @NotNull Function<ERROR,COMMON> errorMerge)

matches

public boolean matches(Predicate<VALUE> condition)

is

@NotNull
public <MAPPED_VALUE>
@NotNull Result<MAPPED_VALUE,ERROR> is(@NotNull
 @NotNull Class<MAPPED_VALUE> type,
 @NotNull
 @NotNull Function<VALUE,ERROR> errorSupplier)

swap

@NotNull
public @NotNull Result<ERROR,VALUE> swap()

consume

public Result<VALUE,ERROR> consume(@NotNull
 @NotNull Consumer<VALUE> valueConsumer,
 @NotNull
 @NotNull Consumer<ERROR> errorConsumer)

project

@NotNull
public <REQUIRED_VALUE,
REQUIRED_ERROR>
@NotNull Result<REQUIRED_VALUE,REQUIRED_ERROR> project()

projectToValue

@NotNull
public <REQUIRED_ERROR>
@NotNull Result<VALUE,REQUIRED_ERROR> projectToValue()

projectToError

@NotNull
public <REQUIRED_VALUE>
@NotNull Result<REQUIRED_VALUE,ERROR> projectToError()

orElse

@NotNull
public @NotNull Result<VALUE,ERROR> orElse(@NotNull
 @NotNull Function<ERROR,@NotNull Result<VALUE,ERROR>> orElse)

orElseGet

@NotNull
public VALUE orElseGet(@NotNull
 @NotNull Function<ERROR,VALUE> orElse)

orThrow

@NotNull
public <E extends Exception> VALUE orThrow(@NotNull
 @NotNull ThrowingFunction<ERROR,E,E> consumer)
                                    throws E

Throws:

E extends Exception

orElseThrow

@Deprecated
@NotNull
public <E extends Exception> VALUE orElseThrow(@NotNull
 @NotNull ThrowingFunction<ERROR,E,E> consumer)
                                        throws E

Deprecated.

Throws:

E extends Exception

See Also:

• orThrow(panda.std.function.ThrowingFunction)

peek

@NotNull
public @NotNull Result<VALUE,ERROR> peek(@NotNull
 @NotNull Consumer<VALUE> consumer)

onError

@NotNull
public @NotNull Result<VALUE,ERROR> onError(@NotNull
 @NotNull Consumer<ERROR> consumer)

isOk

public boolean isOk()

isErr

public boolean isErr()

get

public VALUE get()

getError

public ERROR getError()

getAny

public Object getAny()

getAnyAs

public <AS> AS getAnyAs()

toOption

@NotNull
public @NotNull Option<@NotNull VALUE> toOption()

errorToOption

@NotNull
public @NotNull Option<@NotNull ERROR> errorToOption()

orNull

@Nullable
public VALUE orNull()

getState

public Result.State getState()

equals

public boolean equals(Object to)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object