javascalautils

Class Failure<T>

java.lang.Object

javascalautils.Failure<T>

Type Parameters:

T - The type of the exception represented by this instance

All Implemented Interfaces:

Serializable, Iterable<T>, Try<T>

public final class Failure<T>
extends Object
implements Try<T>, Serializable

Represents the 'failed' implementation of Try.

Since:

1.0

Author:

Peter Nerg

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Failure(Throwable throwable) Creates a Failure for the provided Throwable. Null values are not allowed.

Method Summary

Modifier and Type	Method and Description
Try<Throwable>	failed() Always returns a Success with the Throwable provided in the constructor.
T	get() Always throws the Throwable provided in the constructor.
T	getOrElse(java.util.function.Supplier<T> s) Always returns the provided default value.
boolean	isSuccess() Always returns false.
<R> Try<R>	map(java.util.function.Function<T,R> function) Always returns this
Try<T>	orElse(java.util.function.Supplier<Try<T>> s) Always returns the provided default value.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javascalautils.Try

apply, asOption, isFailure, iterator, orNull, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Failure

public Failure(Throwable throwable)

Creates a Failure for the provided Throwable.
Null values are not allowed.

Parameters:

throwable - The throwable

Method Detail

isSuccess

public boolean isSuccess()

Always returns false.

Specified by:

isSuccess in interface Try<T>

Returns:

If the Try is a Success

getOrElse

public T getOrElse(java.util.function.Supplier<T> s)

Always returns the provided default value.

Specified by:

getOrElse in interface Try<T>

Parameters:

s - The supplier to return the value in case of a Failure

Returns:

The value from the Try or the supplier

orElse

public Try<T> orElse(java.util.function.Supplier<Try<T>> s)

Always returns the provided default value.

Specified by:

orElse in interface Try<T>

Parameters:

s - The supplier to return the value in case of a Failure

Returns:

This try or the value from the supplier

get

public T get()
      throws Throwable

Always throws the Throwable provided in the constructor.

Specified by:

get in interface Try<T>

Returns:

The value of the Try

Throws:

Throwable - The Throwable in case of a Failure

failed

public Try<Throwable> failed()

Always returns a Success with the Throwable provided in the constructor.

Specified by:

failed in interface Try<T>

Returns:

The value of the Failure in a Success

map

public <R> Try<R> map(java.util.function.Function<T,R> function)

Always returns this

Specified by:

map in interface Try<T>

Type Parameters:

R - The type for the return value from the function

Parameters:

function - The function to use

Returns:

The Option containing the mapped value

toString

public String toString()

Overrides:

toString in class Object