Failure (Java Scala Utils 1.9.1 API)

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 failure implementation of Try.
Acts as a carrier for the result/throwable of a unsuccessful computation.
For examples on usage refer to the documentation for 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.

Constructors
Constructor and Description
`Failure(Throwable throwable)` Creates a Failure for the provided Throwable.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Try<Throwable>`	`failed()` Returns a `Success` with the `Throwable` this instance represents.
`Try<T>`	`filter(java.util.function.Predicate<T> predicate)` Always returns this.
`<R> Try<R>`	`flatMap(java.util.function.Function<T,Try<R>> function)` Always returns this.
`T`	`get()` Always throws the `Throwable` this instance represents.
`T`	`getOrElse(java.util.function.Supplier<T> supplier)` Always returns the value provided by the supplier.
`boolean`	`isSuccess()` Always returns `false`.
`Iterator<T>`	`iterator()` Always returns an empty iterator.
`<R> Try<R>`	`map(java.util.function.Function<T,R> function)` Always returns this.
`Try<T>`	`orElse(java.util.function.Supplier<Try<T>> supplier)` Always returns the value provided by the supplier.
`Try<T>`	`recover(java.util.function.Function<Throwable,T> function)` Applies the provided function to the Throwable of this `Failure` and returns a `Success` with the result.
`Try<T>`	`recoverWith(java.util.function.Function<Throwable,Try<T>> function)` Applies the provided function to the Throwable of this `Failure` and returns the result.
`java.util.stream.Stream<T>`	`stream()` Always returns an empty stream.
`String`	`toString()` Returns a String representation of the instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javascalautils.Try
apply, 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 since a 'failure' needs a reason.
    
    Parameters:
    
    throwable - The throwable
    
    Since:
    
    1.0
- Method Detail
  - isSuccess
```
public boolean isSuccess()
```
    Always returns false.
    
    Specified by:
    
    isSuccess in interface Try<T>
    
    Returns:
    
    If the Try is a Success
    
    Since:
    
    1.0
  - getOrElse
```
public T getOrElse(java.util.function.Supplier<T> supplier)
```
    Always returns the value provided by the supplier.
    As per definition this is a failure without any data to return.
    
    Specified by:
    
    getOrElse in interface Try<T>
    
    Parameters:
    
    supplier - The supplier to return the value in case of a Failure
    
    Returns:
    
    The value from the Try or the supplier
    
    Since:
    
    1.0
  - orElse
```
public Try<T> orElse(java.util.function.Supplier<Try<T>> supplier)
```
    Always returns the value provided by the supplier.
    As per definition this is a failure without any data to return.
    
    Specified by:
    
    orElse in interface Try<T>
    
    Parameters:
    
    supplier - The supplier to return the value in case of a Failure
    
    Returns:
    
    This try or the value from the supplier
    
    Since:
    
    1.0
  - get
```
public T get()
      throws Throwable
```
    Always throws the Throwable this instance represents.
    As per definition this is a failure without any data to return.
    
    Specified by:
    
    get in interface Try<T>
    
    Returns:
    
    The value of the Success
    
    Throws:
    
    Throwable - The Throwable in case of a Failure
    
    Since:
    
    1.0
  - failed
```
public Try<Throwable> failed()
```
    Returns a Success with the Throwable this instance represents.
    
    Specified by:
    
    failed in interface Try<T>
    
    Returns:
    
    The value of the Failure in a Success
    
    Since:
    
    1.0
  - map
```
public <R> Try<R> map(java.util.function.Function<T,R> function)
```
    Always returns this.
    As per definition this is a failure without any data to map.
    
    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
    
    Since:
    
    1.0
  - flatMap
```
public <R> Try<R> flatMap(java.util.function.Function<T,Try<R>> function)
```
    Always returns this.
    As per definition this is a failure without any data to map.
    
    Specified by:
    
    flatMap 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
    
    Since:
    
    1.2
  - filter
```
public Try<T> filter(java.util.function.Predicate<T> predicate)
```
    Always returns this.
    As per definition this is a failure without any data to filter.
    
    Specified by:
    
    filter in interface Try<T>
    
    Parameters:
    
    predicate - The filter to apply
    
    Returns:
    
    The try matching the filter, either this if matching or a Failure in case no match
    
    Since:
    
    1.4
  - recover
```
public Try<T> recover(java.util.function.Function<Throwable,T> function)
```
    Applies the provided function to the Throwable of this Failure and returns a Success with the result.
    
    Specified by:
    
    recover in interface Try<T>
    
    Parameters:
    
    function - The function to apply in case of a Failure
    
    Returns:
    
    The recovered Try
    
    Since:
    
    1.4
  - recoverWith
```
public Try<T> recoverWith(java.util.function.Function<Throwable,Try<T>> function)
```
    Applies the provided function to the Throwable of this Failure and returns the result.
    
    Specified by:
    
    recoverWith in interface Try<T>
    
    Parameters:
    
    function - The function to apply in case of a Failure
    
    Returns:
    
    The recovered Try
    
    Since:
    
    1.4
  - toString
```
public String toString()
```
    Returns a String representation of the instance.
    
    Overrides:
    
    toString in class Object
    
    Since:
    
    1.0
  - iterator
```
public final Iterator<T> iterator()
```
    Always returns an empty iterator.
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Returns:
    
    An empty iterator
    
    Since:
    
    1.0
  - stream
```
public final java.util.stream.Stream<T> stream()
```
    Always returns an empty stream.
    
    Returns:
    
    An empty stream
    
    Since:
    
    1.0

Class Failure<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javascalautils.Try

Methods inherited from interface java.lang.Iterable

Constructor Detail

Failure

Method Detail

isSuccess

getOrElse

orElse

get

failed

map

flatMap

filter

recover

recoverWith

toString

iterator

stream