Package ru.progrm_jarvis.javacommons.object

Class Result.Success<T,E>

java.lang.Object

ru.progrm_jarvis.javacommons.object.Result.Success<T,E>

Type Parameters:

T - type of successful result

E - type of error result

All Implemented Interfaces:

Supplier<T>, Result<T,E>

Enclosing interface:

Result<T,E>

public static final class Result.Success<T,@Any E>
extends Object
implements Result<T,E>

Representation of a successful result.

Nested Class Summary

Nested classes/interfaces inherited from interface ru.progrm_jarvis.javacommons.object.Result

Result.Error<T,E>, Result.Extensions, Result.NotErrorException, Result.NotSuccessException, Result.NullError, Result.NullSuccess, Result.Success<T,E>

Constructor Summary

Constructors

Constructor	Description
Success(T value)

Method Summary

Modifier and Type	Method	Description
<R> @NotNull Result<R,E>	and(@NonNull Result<R,@Any E> nextResult)	Returns the given result if this is a successful result otherwise keeping the error result.
@NotNull Optional<E>	asErrorOptional()	Converts this result into an Optional of its error.
@NotNull Stream<E>	asErrorStream()	Converts this result into a Stream of its error value.
@NotNull ValueContainer<E>	asErrorValueContainer()	Converts this result into a ValueContainer of its error value.
@NotNull Optional<T>	asOptional()	Converts this result into an Optional of its successful value.
@NotNull Stream<T>	asStream()	Converts this result into a Stream of its successful value.
@NotNull ValueContainer<T>	asValueContainer()	Converts this result into a ValueContainer of its successful value.
boolean	equals(Object o)
E	errorOrComputeDefault(@NonNull Function<? super T,? extends @Any E> defaultErrorFactory)	Gets the value of this result if this is a successful otherwise returning the value computed by applying the given function to the error value.
E	errorOrDefault(@Any E defaultError)	Gets the error of this result if this is an error otherwise returning default value.
<X extends Throwable> E	errorOrElseThrow(@NonNull Function<? super T,? extends X> exceptionSupplier)	Gets the error of this result throwing X got by using the specified supplier if this is a successful result.
E	errorOrGetDefault(@NonNull Supplier<? extends @Any E> defaultErrorSupplier)	Gets the value of this result if this is an error otherwise returning the value got by using the specified supplier.
E	errorOrNull()	Gets the error of this result if this is an error otherwise returning null.
T	expect(@NonNull String message)	Gets the value of this result throwing a Result.NotSuccessException if this is an error result.
E	expectError(String message)	Gets the error of this result throwing a Result.NotErrorException if this is a successful result.
<R> @NotNull Result<R,E>	flatMap(@NonNull Function<? super T,? extends @NotNull Result<R,@Any E>> mapper)	Also known as andThen.
void	handle(@NonNull Consumer<? super T> successConsumer, @NonNull Consumer<? super @Any E> errorConsumer)	Invokes the corresponding function depending on this result's type.
int	hashCode()
void	ifError(@NonNull Consumer<? super @Any E> errorConsumer)	Invokes the given function if this result is an error result.
void	ifSuccess(@NonNull Consumer<? super T> successConsumer)	Invokes the given function if this result is a successful result.
boolean	isError()	Checks is this result is an error.
boolean	isSuccess()	Checks is this result is successful.
<R> @NotNull Result<R,E>	map(@NonNull Function<? super T,? extends R> mappingFunction)	Maps the result if it is successful returning a new result with the result of mapping otherwise keeping the error result.
<@Any R> @NotNull Result<T,R>	mapError(@NonNull Function<? super @Any E,? extends @Any R> mappingFunction)	Maps the result if it is an error result returning a new result with the result of mapping otherwise keeping the error result.
<@Any R> @NotNull Result<T,R>	or(@NonNull Result<T,@Any R> alternateResult)	Returns this result if this is a successful result otherwise returning the given result.
T	orComputeDefault(@NonNull Function<? super @Any E,? extends T> defaultValueFactory)	Gets the value of this result if this is a successful otherwise returning the value computed by applying the given function to the error value.
T	orDefault(T defaultValue)	Gets the value of this result if this is a successful otherwise returning default value.
<@Any R> @NotNull Result<T,R>	orElse(@NonNull Function<? super @Any E,? extends @NotNull Result<T,@Any R>> mapper)	Maps the result if this is an error result returning the result of mapping otherwise keeping the successful result.
<X extends Throwable> T	orElseThrow(@NonNull Function<? super @Any E,? extends X> exceptionFactory)	Gets the value of this result throwing X got by using the specified supplier if this is an error result.
T	orGetDefault(@NonNull Supplier<? extends T> defaultValueSupplier)	Gets the value of this result if this is a successful otherwise returning the value got by using the specified supplier.
T	orNull()	Gets the value of this result if this is a successful otherwise returning null.
@NotNull Result<T,E>	peek(@NonNull Consumer<? super T> consumer)	Consumes the result if it is successful returning the same result.
@NotNull Result<T,E>	peekError(@NonNull Consumer<? super @Any E> consumer)	Consumes the result if it is an error result returning the same result.
@NotNull Result<E,T>	swap()	Swaps this result making an error result from a successful result and a successful result from an error result.
String	toString()
T	unwrap()	Gets the value of this result throwing a Result.NotSuccessException if this is an error result.
E	unwrapError()	Gets the error of this result throwing a Result.NotErrorException if this is a successful result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ru.progrm_jarvis.javacommons.object.Result

errorOrElseSneakyThrow, get, orElseSneakyThrow

Constructor Details

Success

public Success(T value)

Method Details

isSuccess

public boolean isSuccess()

Description copied from interface: Result

Checks is this result is successful.

Specified by:

isSuccess in interface Result<T,E>

Returns:

true if this is a successful result and false otherwise

isError

public boolean isError()

Description copied from interface: Result

Checks is this result is an error.

Specified by:

isError in interface Result<T,E>

Returns:

true if this is an error result and false otherwise

unwrap

public T unwrap()

Description copied from interface: Result

Gets the value of this result throwing a Result.NotSuccessException if this is an error result.

Specified by:

unwrap in interface Result<T,E>

Returns:

successful value of this result

See Also:

• analog with exception message specification
• analog with exception specification
• analog with unchecked exception specification

expect

public T expect(@NonNull
 @NonNull String message)

Description copied from interface: Result

Gets the value of this result throwing a Result.NotSuccessException if this is an error result.

Specified by:

expect in interface Result<T,E>

Parameters:

message - message to be specified to Result.NotSuccessException

Returns:

successful value of this result

See Also:

• analog with default message
• analog with exception specification
• analog with unchecked exception specification

orElseThrow

public <X extends Throwable> T orElseThrow(@NonNull
 @NonNull Function<? super @Any E,? extends X> exceptionFactory)

Description copied from interface: Result

Gets the value of this result throwing X got by using the specified supplier if this is an error result.

Specified by:

orElseThrow in interface Result<T,E>

Type Parameters:

X - type of exception thrown if this is an error result

Parameters:

exceptionFactory - factory of a thrown exception consuming the error value of this result

Returns:

successful value of this result

See Also:

• NotSuccessException analog
• default message NotSuccessException analog
• unchecked equivalent

orDefault

public T orDefault(T defaultValue)

Description copied from interface: Result

Gets the value of this result if this is a successful otherwise returning default value.

Specified by:

orDefault in interface Result<T,E>

Parameters:

defaultValue - default value to be returned if this is an error value

Returns:

successful value if this a successful result or defaultValue otherwise

orNull

@Nullable
public T orNull()

Description copied from interface: Result

Gets the value of this result if this is a successful otherwise returning null.

Specified by:

orNull in interface Result<T,E>

Returns:

successful value if this a successful result or null otherwise

orGetDefault

public T orGetDefault(@NonNull
 @NonNull Supplier<? extends T> defaultValueSupplier)

Description copied from interface: Result

Gets the value of this result if this is a successful otherwise returning the value got by using the specified supplier.

Specified by:

orGetDefault in interface Result<T,E>

Parameters:

defaultValueSupplier - supplier of the default value to be returned if this is an error value

Returns:

successful value if this a successful result or got default otherwise

orComputeDefault

public T orComputeDefault(@NonNull
 @NonNull Function<? super @Any E,? extends T> defaultValueFactory)

Description copied from interface: Result

Gets the value of this result if this is a successful otherwise returning the value computed by applying the given function to the error value.

Specified by:

orComputeDefault in interface Result<T,E>

Parameters:

defaultValueFactory - factory used for creation of the default value to be returned if this is an error value

Returns:

successful value if this a successful result or the computed default otherwise

unwrapError

public E unwrapError()

Description copied from interface: Result

Gets the error of this result throwing a Result.NotErrorException if this is a successful result.

Specified by:

unwrapError in interface Result<T,E>

Returns:

error value of this result

See Also:

• analog with exception message specification
• analog with exception specification
• analog with unchecked exception specification

expectError

public E expectError(String message)

Description copied from interface: Result

Gets the error of this result throwing a Result.NotErrorException if this is a successful result.

Specified by:

expectError in interface Result<T,E>

Parameters:

message - message to be specified to Result.NotErrorException

Returns:

error value of this result

See Also:

• analog with default message
• analog with exception specification
• analog with unchecked exception specification

errorOrElseThrow

public <X extends Throwable> E errorOrElseThrow(@NonNull
 @NonNull Function<? super T,? extends X> exceptionSupplier)
                                         throws X

Description copied from interface: Result

Gets the error of this result throwing X got by using the specified supplier if this is a successful result.

Specified by:

errorOrElseThrow in interface Result<T,E>

Type Parameters:

X - type of exception thrown if this is a successful result

Parameters:

exceptionSupplier - factory of a thrown exception consuming the successful value of this result

Returns:

error value of this result

Throws:

X - if this is an error result

See Also:

• default message NotErrorException analog
• NotErrorException analog
• unchecked equivalent

errorOrDefault

public E errorOrDefault(@Any E defaultError)

Description copied from interface: Result

Gets the error of this result if this is an error otherwise returning default value.

Specified by:

errorOrDefault in interface Result<T,E>

Parameters:

defaultError - default value to be returned if this is an successful result

Returns:

error value if this an error result or defaultError otherwise

errorOrNull

@Nullable
public E errorOrNull()

Description copied from interface: Result

Gets the error of this result if this is an error otherwise returning null.

Specified by:

errorOrNull in interface Result<T,E>

Returns:

error value if this an error result or null otherwise

errorOrGetDefault

public E errorOrGetDefault(@NonNull
 @NonNull Supplier<? extends @Any E> defaultErrorSupplier)

Description copied from interface: Result

Gets the value of this result if this is an error otherwise returning the value got by using the specified supplier.

Specified by:

errorOrGetDefault in interface Result<T,E>

Parameters:

defaultErrorSupplier - supplier of the default error to be returned if this is a successful value

Returns:

error value if this an error result or got default otherwise

errorOrComputeDefault

public E errorOrComputeDefault(@NonNull
 @NonNull Function<? super T,? extends @Any E> defaultErrorFactory)

Description copied from interface: Result

Gets the value of this result if this is a successful otherwise returning the value computed by applying the given function to the error value.

Specified by:

errorOrComputeDefault in interface Result<T,E>

Parameters:

defaultErrorFactory - factory used for creation of the default error to be returned if this is a successful value

Returns:

successful value if this an error result or the computed default otherwise

ifSuccess

public void ifSuccess(@NonNull
 @NonNull Consumer<? super T> successConsumer)

Description copied from interface: Result

Invokes the given function if this result is a successful result.

Specified by:

ifSuccess in interface Result<T,E>

Parameters:

successConsumer - consumer accepting the successful value

ifError

public void ifError(@NonNull
 @NonNull Consumer<? super @Any E> errorConsumer)

Description copied from interface: Result

Invokes the given function if this result is an error result.

Specified by:

ifError in interface Result<T,E>

Parameters:

errorConsumer - consumer accepting the error value

handle

public void handle(@NonNull
 @NonNull Consumer<? super T> successConsumer,
 @NonNull
 @NonNull Consumer<? super @Any E> errorConsumer)

Description copied from interface: Result

Invokes the corresponding function depending on this result's type.

Specified by:

handle in interface Result<T,E>

Parameters:

successConsumer - consumer accepting the successful value

errorConsumer - consumer accepting the error value

map

@NotNull
public <R> @NotNull Result<R,E> map(@NonNull
 @NonNull Function<? super T,? extends R> mappingFunction)

Description copied from interface: Result

Maps the result if it is successful returning a new result with the result of mapping otherwise keeping the error result.

Specified by:

map in interface Result<T,E>

Type Parameters:

R - type of the resulting successful value

Parameters:

mappingFunction - function to map the successful result

Returns:

mapped successful result if it was a successful result or an error result if it was an error result

peek

@NotNull
public @NotNull Result<T,E> peek(@NonNull
 @NonNull Consumer<? super T> consumer)

Description copied from interface: Result

Consumes the result if it is successful returning the same result.

Specified by:

peek in interface Result<T,E>

Parameters:

consumer - consumer to accept the successful result

Returns:

the same result

mapError

@NotNull
public <@Any R> @NotNull Result<T,R> mapError(@NonNull
 @NonNull Function<? super @Any E,? extends @Any R> mappingFunction)

Description copied from interface: Result

Maps the result if it is an error result returning a new result with the result of mapping otherwise keeping the error result.

Specified by:

mapError in interface Result<T,E>

Type Parameters:

R - type of the resulting error value

Parameters:

mappingFunction - function to map the error result

Returns:

mapped error result if it was an an error result or a successful result if it was a successful result

peekError

@NotNull
public @NotNull Result<T,E> peekError(@NonNull
 @NonNull Consumer<? super @Any E> consumer)

Description copied from interface: Result

Consumes the result if it is an error result returning the same result.

Specified by:

peekError in interface Result<T,E>

Parameters:

consumer - consumer to accept the successful result

Returns:

the same result

and

@NotNull
public <R> @NotNull Result<R,E> and(@NonNull
 @NonNull Result<R,@Any E> nextResult)

Description copied from interface: Result

Returns the given result if this is a successful result otherwise keeping the error result.

Specified by:

and in interface Result<T,E>

Type Parameters:

R - type of the resulting successful value

Parameters:

nextResult - result to be returned if this is a successful result

Returns:

nextResult if this is a successful result or this error result otherwise

See Also:

• lazy analog

flatMap

@NotNull
public <R> @NotNull Result<R,E> flatMap(@NonNull
 @NonNull Function<? super T,? extends @NotNull Result<R,@Any E>> mapper)

Description copied from interface: Result

Also known as andThen. Maps the result if this is a successful result returning the result of mapping otherwise keeping the error result.

Specified by:

flatMap in interface Result<T,E>

Type Parameters:

R - type of the resulting successful value

Parameters:

mapper - function to create a new result from current successful one

Returns:

mapped successful result if this was the one or this error result otherwise

See Also:

• non-lazy analog

or

@NotNull
public <@Any R> @NotNull Result<T,R> or(@NonNull
 @NonNull Result<T,@Any R> alternateResult)

Description copied from interface: Result

Returns this result if this is a successful result otherwise returning the given result.

Specified by:

or in interface Result<T,E>

Type Parameters:

R - type of the resulting error value

Parameters:

alternateResult - result to be returned if this is an error result

Returns:

successful result if this is the one or alternateResult otherwise

See Also:

• lazy analog

orElse

@NotNull
public <@Any R> @NotNull Result<T,R> orElse(@NonNull
 @NonNull Function<? super @Any E,? extends @NotNull Result<T,@Any R>> mapper)

Description copied from interface: Result

Maps the result if this is an error result returning the result of mapping otherwise keeping the successful result.

Specified by:

orElse in interface Result<T,E>

Type Parameters:

R - type of the resulting error value

Parameters:

mapper - function to create a new result from current error one

Returns:

mapped error result if this was the one or this successful result otherwise

See Also:

• non-lazy analog

swap

@NotNull
public @NotNull Result<E,T> swap()

Description copied from interface: Result

Swaps this result making an error result from a successful result and a successful result from an error result.

Specified by:

swap in interface Result<T,E>

Returns:

error result if this was a successful result and a successful result if this was an error result

asOptional

@NotNull
public @NotNull Optional<T> asOptional()

Description copied from interface: Result

Converts this result into an Optional of its successful value.

Specified by:

asOptional in interface Result<T,E>

Returns:

optional containing the value if this is a successful result or an empty optional otherwise

asErrorOptional

@NotNull
public @NotNull Optional<E> asErrorOptional()

Description copied from interface: Result

Converts this result into an Optional of its error.

Specified by:

asErrorOptional in interface Result<T,E>

Returns:

optional containing the error if this is an error result or an empty optional otherwise

asValueContainer

@NotNull
public @NotNull ValueContainer<T> asValueContainer()

Description copied from interface: Result

Converts this result into a ValueContainer of its successful value.

Specified by:

asValueContainer in interface Result<T,E>

Returns:

value container containing the value if this is a successful result or an empty value-container otherwise

asErrorValueContainer

@NotNull
public @NotNull ValueContainer<E> asErrorValueContainer()

Description copied from interface: Result

Converts this result into a ValueContainer of its error value.

Specified by:

asErrorValueContainer in interface Result<T,E>

Returns:

value container containing the error if this is an error result or an empty value-container otherwise

asStream

@NotNull
public @NotNull Stream<T> asStream()

Description copied from interface: Result

Converts this result into a Stream of its successful value.

Specified by:

asStream in interface Result<T,E>

Returns:

stream of the value if this is a successful result or an empty stream otherwise

asErrorStream

@NotNull
public @NotNull Stream<E> asErrorStream()

Description copied from interface: Result

Converts this result into a Stream of its error value.

Specified by:

asErrorStream in interface Result<T,E>

Returns:

stream containing the error if this is an error result or an empty stream otherwise

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