Class Try.Failure<T>

java.lang.Object

io.vavr.control.Try.Failure<T>

Type Parameters:

T - the type of the value that would have been contained if successful

All Implemented Interfaces:

Try<T>, Value<T>, Serializable, Iterable<T>

Enclosing interface:

Try<T>

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

Represents a failed Try containing a Throwable as the cause.

Instances of this class indicate that the computation threw an exception and do not contain a successful value.

Try<Integer> failure = new Try.Failure<>(new RuntimeException("error"));
failure.isFailure();  // true
failure.getCause();   // RuntimeException: error

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Try

Try.Failure<T>, Try.Success<T>, Try.WithResources1<T1>, Try.WithResources2<T1,T2>, Try.WithResources3<T1,T2,T3>, Try.WithResources4<T1,T2,T3,T4>, Try.WithResources5<T1,T2,T3,T4,T5>, Try.WithResources6<T1,T2,T3,T4,T5,T6>, Try.WithResources7<T1,T2,T3,T4,T5,T6,T7>, Try.WithResources8<T1,T2,T3,T4,T5,T6,T7,T8>

Field Summary

Fields

Modifier and Type	Field	Description
private final Throwable	cause
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Failure(Throwable cause)	Constructs a Failure.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Clarifies that values have a proper equals() method implemented.
T	get()	Returns the value of this Try if it is a Try.Success, or throws the underlying exception if it is a Try.Failure.
Throwable	getCause()	Returns the cause of failure if this Try is a Try.Failure.
int	hashCode()	Clarifies that values have a proper hashCode() method implemented.
boolean	isEmpty()	Checks whether this Try contains no value, i.e., it is a Try.Failure.
boolean	isFailure()	Checks whether this Try is a Try.Failure.
boolean	isSuccess()	Checks whether this Try is a Try.Success.
String	stringPrefix()	Returns the name of this Value type, which is used by toString().
String	toString()	Clarifies that values have a proper toString() method implemented.

Methods inherited from class Object

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

Methods inherited from interface Try

andFinally, andFinallyTry, andThen, andThen, andThenTry, andThenTry, collect, failed, filter, filter, filter, filterTry, filterTry, filterTry, flatMap, flatMapTry, fold, getOrElseGet, getOrElseThrow, isAsync, isLazy, isSingleValued, iterator, map, mapFailure, mapTo, mapToVoid, mapTry, onFailure, onFailure, onSuccess, orElse, orElse, orElseRun, peek, recover, recover, recover, recoverAllAndTry, recoverAndTry, recoverWith, recoverWith, recoverWith, toEither, toEither, toValidation, toValidation, transform

Methods inherited from interface Value

collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, out, out, spliterator, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

cause

private final Throwable cause

Constructor Details

Failure

private Failure(Throwable cause)

Constructs a Failure.

Parameters:

cause - A cause of type Throwable, may not be null.

Throws:

NullPointerException - if cause is null. Additionally, if the given cause is fatal (i.e. non-recoverable), it is thrown sneakily without being declared in the method signature.

Method Details

get

public T get()

Description copied from interface: Try

Returns the value of this Try if it is a Try.Success, or throws the underlying exception if it is a Try.Failure.

Important: If this Try is a Try.Failure, the exception thrown is exactly the Try.getCause() of this Failure. The underlying cause is thrown sneakily (without being declared in the method signature).

Specified by:

get in interface Try<T>

Specified by:

get in interface Value<T>

Returns:

the value contained in this Success

getCause

public Throwable getCause()

Description copied from interface: Try

Returns the cause of failure if this Try is a Try.Failure.

Specified by:

getCause in interface Try<T>

Returns:

the throwable cause of this Try.Failure

isEmpty

public boolean isEmpty()

Description copied from interface: Try

Checks whether this Try contains no value, i.e., it is a Try.Failure.

Specified by:

isEmpty in interface Try<T>

Specified by:

isEmpty in interface Value<T>

Returns:

true if this is a Try.Failure, false if this is a Try.Success

isFailure

public boolean isFailure()

Description copied from interface: Try

Checks whether this Try is a Try.Failure.

Specified by:

isFailure in interface Try<T>

Returns:

true if this is a Try.Failure, false if this is a Try.Success

isSuccess

public boolean isSuccess()

Description copied from interface: Try

Checks whether this Try is a Try.Success.

Specified by:

isSuccess in interface Try<T>

Returns:

true if this is a Try.Success, false if this is a Try.Failure

equals

public boolean equals(Object obj)

Description copied from interface: Value

Clarifies that values have a proper equals() method implemented.

See Object.equals(Object).

Specified by:

equals in interface Try<T>

Specified by:

equals in interface Value<T>

Overrides:

equals in class Object

Parameters:

obj - An object

Returns:

true, if this equals o, false otherwise

stringPrefix

public String stringPrefix()

Description copied from interface: Value

Returns the name of this Value type, which is used by toString().

Specified by:

stringPrefix in interface Value<T>

Returns:

This type name.

hashCode

public int hashCode()

Description copied from interface: Value

Clarifies that values have a proper hashCode() method implemented.

See Object.hashCode().

Specified by:

hashCode in interface Try<T>

Specified by:

hashCode in interface Value<T>

Overrides:

hashCode in class Object

Returns:

The hashcode of this object

toString

public String toString()

Description copied from interface: Value

Clarifies that values have a proper toString() method implemented.

See Object.toString().

Specified by:

toString in interface Try<T>

Specified by:

toString in interface Value<T>

Overrides:

toString in class Object

Returns:

A String representation of this object