Failure (cyclops-try 7.2.3 API)

java.lang.Object
- com.aol.cyclops.trycatch.Failure<T,X>

Type Parameters:

T - Value type

X - Error type

All Implemented Interfaces:

com.aol.cyclops.matcher.recursive.Matchable, com.aol.cyclops.objects.Decomposable, com.aol.cyclops.sequence.streamable.ToStream<T>, Try<T,X>, com.aol.cyclops.value.ValueObject, java.lang.Iterable<T>, java.util.function.Supplier<T>
```
public class Failure<T,X extends java.lang.Throwable>
extends java.lang.Object
implements Try<T,X>
```
Class that represents the Failure of a Try

Nested Class Summary
- Nested classes/interfaces inherited from interface com.aol.cyclops.trycatch.Try
  Try.AndFinally<T,V,X extends java.lang.Throwable>, Try.CheckedConsumer<T,X extends java.lang.Throwable>, Try.CheckedFunction<T,R,X extends java.lang.Throwable>, Try.CheckedRunnable<X extends java.lang.Throwable>, Try.CheckedSupplier<T,X extends java.lang.Throwable>, Try.Init<X extends java.lang.Throwable>, Try.MyFinallyBlock<T,V,X extends java.lang.Throwable>, Try.MyInit<X extends java.lang.Throwable>, Try.MyTryCatch<V,X extends java.lang.Throwable>, Try.TryCatch<V,X extends java.lang.Throwable>

Constructor Summary

Constructors
Constructor and Description

Failure()

Constructors
Constructor and Description
`Failure()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.aol.cyclops.monad.AnyM<T>`	`anyM()`
`com.aol.cyclops.monad.AnyM<X>`	`anyMFailure()`
`static <T,X extends java.lang.Throwable> com.aol.cyclops.monad.AnyM<X>`	`anyMOf(X error)` Construct a Failure instance from a throwable
`com.aol.cyclops.monad.AnyM<T>`	`anyMSuccess()`
`java.util.Optional<T>`	`filter(java.util.function.Predicate<T> p)`
`<R> Try<R,X>`	`flatMap(java.util.function.Function<T,Try<R,X>> fn)`
`Try<T,X>`	`flatten()` Flatten a nested Try Structure
`void`	`foreach(java.util.function.Consumer<T> consumer)`
`void`	`foreachFailed(java.util.function.Consumer<X> consumer)`
`T`	`get()`
`boolean`	`isFailure()`
`boolean`	`isSuccess()`
`<R> Try<R,X>`	`map(java.util.function.Function<T,R> fn)`
`static <T,X extends java.lang.Throwable> Failure<T,X>`	`of(X error)` Construct a Failure instance from a throwable
`Try<T,X>`	`onFail(java.lang.Class<? extends X> t, java.util.function.Consumer<X> consumer)`
`Try<T,X>`	`onFail(java.util.function.Consumer<X> consumer)`
`T`	`orElse(T value)`
`T`	`orElseGet(java.util.function.Supplier<T> value)`
`Success<T,X>`	`recover(java.util.function.Function<X,T> fn)`
`Try<T,X>`	`recoverFor(java.lang.Class<? extends X> t, java.util.function.Function<X,T> fn)` Recover if exception is of specified type
`Success<T,X>`	`recoverWith(java.util.function.Function<X,Success<T,X>> fn)` flatMap recovery
`Try<T,X>`	`recoverWithFor(java.lang.Class<? extends X> t, java.util.function.Function<X,Success<T,X>> fn)` FlatMap recovery function if exception is of specified type
`java.util.stream.Stream<T>`	`stream()`
`void`	`throwException()` Throw exception if Failure, do nothing if success
`java.util.Optional<X>`	`toFailedOptional()`
`java.util.stream.Stream<X>`	`toFailedStream()`
`java.util.Optional<T>`	`toOptional()`
`<T extends java.lang.Iterable<?>> T`	`unapply()`

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

Methods inherited from interface com.aol.cyclops.trycatch.Try
catchExceptions, of, peek, peekFailed, runWithCatch, withCatch

Methods inherited from interface com.aol.cyclops.matcher.recursive.Matchable
getMatchable, listOfValues, matches, matches, matches, matches, matches, mayMatch, mayMatch, mayMatch, mayMatch, mayMatch, ofDecomposable, ofStream

Methods inherited from interface com.aol.cyclops.objects.Decomposable
unwrap

Methods inherited from interface com.aol.cyclops.sequence.streamable.ToStream
getStreamable, isEmpty, iterator, reveresedSequenceM, reveresedStream, sequenceM

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Failure
```
public Failure()
```
- Method Detail
  - unapply
```
public <T extends java.lang.Iterable<?>> T unapply()
```
    Specified by:
    
    unapply in interface com.aol.cyclops.objects.Decomposable
  - anyM
```
public com.aol.cyclops.monad.AnyM<T> anyM()
```
    Specified by:
    
    anyM in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    This monad, wrapped as AnyM of Success
  - anyMFailure
```
public com.aol.cyclops.monad.AnyM<X> anyMFailure()
```
    Specified by:
    
    anyMFailure in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    This monad, wrapped as AnyM of Failure
  - anyMSuccess
```
public com.aol.cyclops.monad.AnyM<T> anyMSuccess()
```
    Specified by:
    
    anyMSuccess in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    This monad, wrapped as AnyM of Success
  - of
```
public static <T,X extends java.lang.Throwable> Failure<T,X> of(X error)
```
    Construct a Failure instance from a throwable
    
    Specified by:
    
    of in interface com.aol.cyclops.matcher.recursive.Matchable
    
    Parameters:
    
    error - for Failure
    
    Returns:
    
    new Failure with error
  - anyMOf
```
public static <T,X extends java.lang.Throwable> com.aol.cyclops.monad.AnyM<X> anyMOf(X error)
```
    Construct a Failure instance from a throwable
    
    Parameters:
    
    error - for Failure
    
    Returns:
    
    new Failure with error
  - get
```
public T get()
```
    Specified by:
    
    get in interface Try<T,X extends java.lang.Throwable>
    
    Specified by:
    
    get in interface java.util.function.Supplier<T>
    
    Returns:
    
    Successful value or will throw Throwable (X) if Failire
  - map
```
public <R> Try<R,X> map(java.util.function.Function<T,R> fn)
```
    Specified by:
    
    map in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    fn - Map success value from T to R. Do nothing if Failure (return this)
    
    Returns:
    
    New Try with mapped value (Success) or this (Failure)
  - flatMap
```
public <R> Try<R,X> flatMap(java.util.function.Function<T,Try<R,X>> fn)
```
    Specified by:
    
    flatMap in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    fn - FlatMap success value or Do nothing if Failure (return this)
    
    Returns:
    
    Try returned from FlatMap fn
  - filter
```
public java.util.Optional<T> filter(java.util.function.Predicate<T> p)
```
    Specified by:
    
    filter in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    p - Convert a Success to a Failure (with a null value for Exception) if predicate does not hold. Do nothing to a Failure
    
    Returns:
    
    this if Success and Predicate holds, or if Failure. New Failure if Success and Predicate fails
  - recoverWithFor
```
public Try<T,X> recoverWithFor(java.lang.Class<? extends X> t,
                               java.util.function.Function<X,Success<T,X>> fn)
```
    Description copied from interface: Try
    
    FlatMap recovery function if exception is of specified type
    
    Specified by:
    
    recoverWithFor in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    t - Type of exception to match against
    
    fn - Recovery FlatMap function. Map from a failure to a Success
    
    Returns:
    
    Success from recovery function or this and types match or if already Success
  - recoverFor
```
public Try<T,X> recoverFor(java.lang.Class<? extends X> t,
                           java.util.function.Function<X,T> fn)
```
    Description copied from interface: Try
    
    Recover if exception is of specified type
    
    Specified by:
    
    recoverFor in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    t - Type of exception to match against
    
    fn - Recovery function
    
    Returns:
    
    New Success if failure and types match / otherwise this
  - recover
```
public Success<T,X> recover(java.util.function.Function<X,T> fn)
```
    Specified by:
    
    recover in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    fn - Recovery function - map from a failure to a Success.
    
    Returns:
    
    new Success
  - recoverWith
```
public Success<T,X> recoverWith(java.util.function.Function<X,Success<T,X>> fn)
```
    Description copied from interface: Try
    
    flatMap recovery
    
    Specified by:
    
    recoverWith in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    fn - Recovery FlatMap function. Map from a failure to a Success
    
    Returns:
    
    Success from recovery function
  - flatten
```
public Try<T,X> flatten()
```
    Description copied from interface: Try
    
    Flatten a nested Try Structure
    
    Specified by:
    
    flatten in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    Lowest nested Try
  - orElse
```
public T orElse(T value)
```
    Specified by:
    
    orElse in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    value - Return value supplied if Failure, otherwise return Success value
    
    Returns:
    
    Success value or supplied value
  - orElseGet
```
public T orElseGet(java.util.function.Supplier<T> value)
```
    Specified by:
    
    orElseGet in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    value - from supplied Supplier if Failure otherwise return Success value
    
    Returns:
    
    Success value
  - toOptional
```
public java.util.Optional<T> toOptional()
```
    Specified by:
    
    toOptional in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    Optional present if Success, Optional empty if failure
  - stream
```
public java.util.stream.Stream<T> stream()
```
    Specified by:
    
    stream in interface com.aol.cyclops.sequence.streamable.ToStream<T>
    
    Specified by:
    
    stream in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    Stream with value if Sucess, Empty Stream if failure
  - isSuccess
```
public boolean isSuccess()
```
    Specified by:
    
    isSuccess in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    true if Success / false if Failure
  - isFailure
```
public boolean isFailure()
```
    Specified by:
    
    isFailure in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    True if Failure / false if Success
  - foreach
```
public void foreach(java.util.function.Consumer<T> consumer)
```
    Specified by:
    
    foreach in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    consumer - Accept value if Success / not called on Failure
  - onFail
```
public Try<T,X> onFail(java.util.function.Consumer<X> consumer)
```
    Specified by:
    
    onFail in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    consumer - Accept Exception if present (Failure)
    
    Returns:
    
    this
  - onFail
```
public Try<T,X> onFail(java.lang.Class<? extends X> t,
                       java.util.function.Consumer<X> consumer)
```
    Specified by:
    
    onFail in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    t - Class type of match Exception against
    
    consumer - Accept Exception if present (Failure) and if class types match
    
    Returns:
    
    this
  - throwException
```
public void throwException()
```
    Description copied from interface: Try
    
    Throw exception if Failure, do nothing if success
    
    Specified by:
    
    throwException in interface Try<T,X extends java.lang.Throwable>
  - toFailedOptional
```
public java.util.Optional<X> toFailedOptional()
```
    Specified by:
    
    toFailedOptional in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    Optional present if Failure (with Exception), Optional empty if Success
  - toFailedStream
```
public java.util.stream.Stream<X> toFailedStream()
```
    Specified by:
    
    toFailedStream in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    Stream with error if Failure, Empty Stream if success
  - foreachFailed
```
public void foreachFailed(java.util.function.Consumer<X> consumer)
```
    Specified by:
    
    foreachFailed in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    consumer - Accept value if Failure / not called on Failure

Class Failure<T,X extends java.lang.Throwable>

Nested Class Summary

Nested classes/interfaces inherited from interface com.aol.cyclops.trycatch.Try

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.aol.cyclops.trycatch.Try

Methods inherited from interface com.aol.cyclops.matcher.recursive.Matchable

Methods inherited from interface com.aol.cyclops.objects.Decomposable

Methods inherited from interface com.aol.cyclops.sequence.streamable.ToStream

Methods inherited from interface java.lang.Iterable

Constructor Detail

Failure

Method Detail

unapply

anyM

anyMFailure

anyMSuccess

of

anyMOf

get

map

flatMap

filter

recoverWithFor

recoverFor

recover

recoverWith

flatten

orElse

orElseGet

toOptional

stream

isSuccess

isFailure

foreach

onFail

onFail

throwException

toFailedOptional

toFailedStream

foreachFailed