no.finn.lambdacompanion

Class Success<T>

java.lang.Object

no.finn.lambdacompanion.Try<T>

no.finn.lambdacompanion.Success<T>

public class Success<T>
extends Try<T>

Constructor Summary

Constructors

Constructor and Description
Success(T t)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<Try<T>>	filter(Predicate<T> predicate) Applies a filter, where a match returns Success and Failure otherwise.
<U> Try<U>	flatMap(ThrowingFunction<? super T,? extends Try<U>,? extends Exception> mapper) Applies a function on two values.
void	forEach(ThrowingConsumer<? super T,? extends Exception> consumer) Accepts a consuming function and applies it to the value if it is a Success.
int	hashCode()
<U> Try<U>	map(ThrowingFunction<? super T,? extends U,? extends Exception> mapper) Applies a function on a value of type Success.
T	orElse(T defaultValue) Returns the value of the Success, or a default value of the same type if this is a Failure.
T	orElseGet(Supplier<? extends T> defaultValue) Returns the value of the Success, or lazily falls back to a supplied value of the same type
<E extends Exception> T	orElseRethrow() Escapes the Try and enters a regular try-catch flow by rethowing the caught exception when a Failure
<X extends Exception,Y extends Exception> T	orElseThrow(Function<X,Y> ExceptionMapper) Escapes the Try and enters a regular try-catch flow
Try<T>	peek(ThrowingConsumer<? super T,? extends Exception> consumer) Same as forEach but returns the Try for further chaining
Try<T>	peekFailure(Consumer<Failure<T>> consumer) Does nothing on Success, but accepts a consumer on Failure
<U> U	recover(Function<? super T,? extends U> successFunc, Function<Exception,? extends U> failureFunc) Accepts two functions, the first applied if Success - returning the value, the other executed if Failure, returning a fallback value.
Either<? extends Exception,T>	toEither() Creates an Either where the Left is the Failure and Right is the Success from this Try
Optional<T>	toOptional() Creates an Optional wrapping the value if Success.
String	toString()

Methods inherited from class no.finn.lambdacompanion.Try

failure, of, of, of, sequence

Methods inherited from class java.lang.Object

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

Constructor Detail

Success

public Success(T t)

Method Detail

map

public <U> Try<U> map(ThrowingFunction<? super T,? extends U,? extends Exception> mapper)

Description copied from class: Try

Applies a function on a value of type Success. Returns self if Failure.

Specified by:

map in class Try<T>

Type Parameters:

U - Type of the return value of the function

Parameters:

mapper - Function from T to U with an Exception in the signature

Returns:

a new Try

flatMap

public <U> Try<U> flatMap(ThrowingFunction<? super T,? extends Try<U>,? extends Exception> mapper)

Description copied from class: Try

Applies a function on two values. Returns Success of the resulting value, or Returns self if Failure. Same as map() but needs a function ending in a Try

Specified by:

flatMap in class Try<T>

Type Parameters:

U - Type of the value to be wrapped in a Try of the function

Parameters:

mapper - Function from T to Try<U> with an Exception in the signature

Returns:

a new Try

filter

public Optional<Try<T>> filter(Predicate<T> predicate)

Description copied from class: Try

Applies a filter, where a match returns Success and Failure otherwise.

Specified by:

filter in class Try<T>

Parameters:

predicate - Predicate function to determine Success or Failure

Returns:

the same or new try

forEach

public void forEach(ThrowingConsumer<? super T,? extends Exception> consumer)

Description copied from class: Try

Accepts a consuming function and applies it to the value if it is a Success. Does nothing if Failure.

Specified by:

forEach in class Try<T>

Parameters:

consumer - Consuming function with an Exception in the signature

peek

public Try<T> peek(ThrowingConsumer<? super T,? extends Exception> consumer)

Description copied from class: Try

Same as forEach but returns the Try for further chaining

Specified by:

peek in class Try<T>

Parameters:

consumer - Consuming function with an Exception in the signature

Returns:

the same Try

peekFailure

public Try<T> peekFailure(Consumer<Failure<T>> consumer)

Description copied from class: Try

Does nothing on Success, but accepts a consumer on Failure

Specified by:

peekFailure in class Try<T>

Parameters:

consumer - Consuming function with a failure

Returns:

the same Try

orElse

public T orElse(T defaultValue)

Description copied from class: Try

Returns the value of the Success, or a default value of the same type if this is a Failure. Note that the argument is always evaluated, and this is not lazy (as opposed to orElseGet)

Specified by:

orElse in class Try<T>

Parameters:

defaultValue - default fallback value

Returns:

value

orElseGet

public T orElseGet(Supplier<? extends T> defaultValue)

Description copied from class: Try

Returns the value of the Success, or lazily falls back to a supplied value of the same type

Specified by:

orElseGet in class Try<T>

Parameters:

defaultValue - lazy default supplier of fallback value

Returns:

value

toOptional

public Optional<T> toOptional()

Description copied from class: Try

Creates an Optional wrapping the value if Success. Creates an empty Optional if Failure.

Specified by:

toOptional in class Try<T>

Returns:

An Optional

recover

public <U> U recover(Function<? super T,? extends U> successFunc,
                     Function<Exception,? extends U> failureFunc)

Description copied from class: Try

Accepts two functions, the first applied if Success - returning the value, the other executed if Failure, returning a fallback value. Note that - the first function cannot have an Exception in its signature. - the fallback function must end in a value

Specified by:

recover in class Try<T>

Type Parameters:

U - Type of the value

Parameters:

successFunc - Function handling the Success case

failureFunc - Function handling the Failure case

Returns:

a value of type U

toEither

public Either<? extends Exception,T> toEither()

Description copied from class: Try

Creates an Either where the Left is the Failure and Right is the Success from this Try

Specified by:

toEither in class Try<T>

Returns:

an Either

orElseThrow

public <X extends Exception,Y extends Exception> T orElseThrow(Function<X,Y> ExceptionMapper)
                                                        throws Y extends Exception

Description copied from class: Try

Escapes the Try and enters a regular try-catch flow

Specified by:

orElseThrow in class Try<T>

Type Parameters:

X - any Exception

Y - any Exception

Parameters:

ExceptionMapper - Function to transform the Exception if this is a Failure

Returns:

Value or a transformed Exception

Throws:

Y - any Exception

Y extends Exception

orElseRethrow

public <E extends Exception> T orElseRethrow()
                                      throws E extends Exception

Description copied from class: Try

Escapes the Try and enters a regular try-catch flow by rethowing the caught exception when a Failure

Specified by:

orElseRethrow in class Try<T>

Type Parameters:

E - any Exception

Returns:

Value or a transformed Exception

Throws:

E - any Exception

E extends Exception

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object