com.aol.cyclops.control

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

java.lang.Object

com.aol.cyclops.control.Try.Failure<T,X>

Type Parameters:

T - Value type

X - Error type

All Implemented Interfaces:

Matchable<T>, Try<T,X>, Applicativable<T>, Convertable<T>, ConvertableFunctor<T>, Filterable<T>, Foldable<T>, Functor<T>, ConvertableToReactiveSeq<T>, ToStream<T>, Unit<T>, Value<T>, java.lang.Iterable<T>, java.util.function.Predicate<T>, java.util.function.Supplier<T>, org.reactivestreams.Publisher<T>

Enclosing interface:

Try<T,X extends java.lang.Throwable>

public static class Try.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.control.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.Failure<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.Success<T,X extends java.lang.Throwable>, Try.TryCatch<V,X extends java.lang.Throwable>

Nested classes/interfaces inherited from interface com.aol.cyclops.types.applicative.Applicativable

Applicativable.Applicatives, Applicativable.SemigroupApplyer<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.types.Value

Value.ValueImpl<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.control.Matchable

Matchable.AsMatchable, Matchable.AutoCloseableMatchableIterable<TYPE>, Matchable.CheckValue1<T,R>, Matchable.CheckValue2<T1,T2,R>, Matchable.CheckValue3<T1,T2,T3,R>, Matchable.CheckValue4<T1,T2,T3,T4,R>, Matchable.CheckValue5<T1,T2,T3,T4,T5,R>, Matchable.CheckValueOpt<T,R>, Matchable.CheckValues<T,R>, Matchable.MatchableIterable<TYPE>, Matchable.MatchableObject<TYPE>, Matchable.MatchableOptional<T>, Matchable.MatchSelf<TYPE>, Matchable.MTuple1<T1>, Matchable.MTuple2<T1,T2>, Matchable.MTuple3<T1,T2,T3>, Matchable.MTuple4<T1,T2,T3,T4>, Matchable.MTuple5<T1,T2,T3,T4,T5>, Matchable.MXor<T1,T2>, Matchable.ValueAndOptionalMatcher<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.types.Convertable

Convertable.SupplierToConvertable<T>

Constructor Summary

Constructors

Constructor and Description
Failure()

Method Summary

Modifier and Type	Method and Description
AnyMValue<T>	anyM()
AnyMValue<X>	anyMFailure()
static <T,X extends java.lang.Throwable> AnyM<X>	anyMOf(X error) Construct a Failure instance from a throwable
AnyMValue<T>	anyMSuccess()
X	failureGet()
Maybe<T>	filter(java.util.function.Predicate<? super T> p)
<R> Try<R,X>	flatMap(java.util.function.Function<? super T,? extends Try<R,X>> fn)
Try<T,X>	flatten() Flatten a nested Try Structure
void	forEach(java.util.function.Consumer<? super T> consumer)
void	forEachFailed(java.util.function.Consumer<? super X> consumer)
T	get()
boolean	isFailure()
boolean	isSuccess()
<R> Try<R,X>	map(java.util.function.Function<? super T,? extends R> fn)
java.lang.String	mkString()
static <T,X extends java.lang.Throwable> Try.Failure<T,X>	of(X error) Deprecated.
Try<T,X>	onFail(java.lang.Class<? extends X> t, java.util.function.Consumer<X> consumer)
Try<T,X>	onFail(java.util.function.Consumer<? super X> consumer)
T	orElse(T value) Get the contained value or else the provided alternative
T	orElseGet(java.util.function.Supplier<? extends T> value)
Try.Success<T,X>	recover(java.util.function.Function<? super X,? extends T> fn)
Try<T,X>	recoverFor(java.lang.Class<? extends X> t, java.util.function.Function<? super X,? extends T> fn) Recover if exception is of specified type
Try.Success<T,X>	recoverWith(java.util.function.Function<? super X,? extends Try.Success<T,X>> fn) flatMap recovery
Try<T,X>	recoverWithFor(java.lang.Class<? extends X> t, java.util.function.Function<? super X,? extends Try.Success<T,X>> fn) FlatMap recovery function if exception is of specified type
ReactiveSeq<T>	stream()
void	throwException() Throw exception if Failure, do nothing if success
java.util.Optional<X>	toFailedOptional()
java.util.stream.Stream<X>	toFailedStream()
Ior<X,T>	toIor()
java.util.Optional<T>	toOptional()
Xor<X,T>	toXor()
ListX<X>	unapply()
<R> R	visit(java.util.function.Function<? super T,? extends R> success, java.util.function.Function<? super X,? extends R> failure)

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.control.Try

cast, catchExceptions, failure, filterNot, iterator, matches, notNull, of, ofType, patternMatch, peek, peekFailed, runWithCatch, success, toXorWithError, trampoline, unit, withCatch

Methods inherited from interface com.aol.cyclops.types.stream.ToStream

getStreamable, isEmpty, jdkStream, reactiveSeq, reveresedJDKStream, reveresedStream

Methods inherited from interface com.aol.cyclops.types.applicative.Applicativable

ap, ap, ap1, ap2, ap3, ap4, ap5

Methods inherited from interface com.aol.cyclops.types.Value

convertTo, convertToAsync, fold, fold, generate, getMatchable, iterate, newSubscriber, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFutureStream, toFutureStream, toLazyImmutable, toListX, toMaybe, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry

Methods inherited from interface com.aol.cyclops.types.Foldable

foldRight, foldRight, foldRight, foldRightMapToType, join, join, join, mapReduce, print, print, printErr, printOut, reduce, reduce, reduce, reduce, reduce, reduce, reduce

Methods inherited from interface com.aol.cyclops.control.Matchable

from, from, from, from, from, from, from, from, from, from, fromCharSequence, fromIterable, fromOptional, listOfValues, ofDecomposable, otherwise, otherwise, then, then, when, when, when, when, when, when, when, when, when, when, whenGuard, whenTrue, whenValues

Methods inherited from interface com.aol.cyclops.types.Convertable

fromSupplier, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toList, toOptionalAtomicReference, toStream, visit

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

Failure

public Failure()

Method Detail

mkString

public java.lang.String mkString()

Specified by:

mkString in interface Value<T>

unapply

public ListX<X> unapply()

Specified by:

unapply in interface Value<T>

toXor

public Xor<X,T> toXor()

Specified by:

toXor in interface Try<T,X extends java.lang.Throwable>

Specified by:

toXor in interface Value<T>

toIor

public Ior<X,T> toIor()

Specified by:

toIor in interface Try<T,X extends java.lang.Throwable>

Specified by:

toIor in interface Value<T>

anyM

public AnyMValue<T> anyM()

Specified by:

anyM in interface Try<T,X extends java.lang.Throwable>

Returns:

This monad, wrapped as AnyM of Success

anyMFailure

public AnyMValue<X> anyMFailure()

Specified by:

anyMFailure in interface Try<T,X extends java.lang.Throwable>

Returns:

This monad, wrapped as AnyM of Failure

anyMSuccess

public AnyMValue<T> anyMSuccess()

Specified by:

anyMSuccess in interface Try<T,X extends java.lang.Throwable>

Returns:

This monad, wrapped as AnyM of Success

failureGet

public X failureGet()

Specified by:

failureGet in interface Try<T,X extends java.lang.Throwable>

of

@Deprecated
public static <T,X extends java.lang.Throwable> Try.Failure<T,X> of(X error)

Deprecated.

Construct a Failure instance from a throwable

Specified by:

of in interface Matchable<T>

Specified by:

of in interface Value<T>

Parameters:

error - for Failure

Returns:

new Failure with error

anyMOf

public static <T,X extends java.lang.Throwable> 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 Convertable<T>

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<? super T,? extends R> fn)

Specified by:

map in interface Try<T,X extends java.lang.Throwable>

Specified by:

map in interface ConvertableFunctor<T>

Specified by:

map in interface Functor<T>

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<? super T,? extends 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 Maybe<T> filter(java.util.function.Predicate<? super T> p)

Specified by:

filter in interface Try<T,X extends java.lang.Throwable>

Specified by:

filter in interface Filterable<T>

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<? super X,? extends Try.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<? super X,? extends 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 Try.Success<T,X> recover(java.util.function.Function<? super X,? extends 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 Try.Success<T,X> recoverWith(java.util.function.Function<? super X,? extends Try.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)

Description copied from interface: Convertable

Get the contained value or else the provided alternative

Specified by:

orElse in interface Try<T,X extends java.lang.Throwable>

Specified by:

orElse in interface Convertable<T>

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<? extends T> value)

Specified by:

orElseGet in interface Try<T,X extends java.lang.Throwable>

Specified by:

orElseGet in interface Convertable<T>

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>

Specified by:

toOptional in interface Convertable<T>

Returns:

Optional present if Success, Optional empty if failure

stream

public ReactiveSeq<T> stream()

Specified by:

stream in interface Try<T,X extends java.lang.Throwable>

Specified by:

stream in interface Foldable<T>

Specified by:

stream in interface ToStream<T>

Specified by:

stream in interface Value<T>

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<? super T> consumer)

Specified by:

forEach in interface Try<T,X extends java.lang.Throwable>

Specified by:

forEach in interface java.lang.Iterable<T>

Parameters:

consumer - Accept value if Success / not called on Failure

onFail

public Try<T,X> onFail(java.util.function.Consumer<? super 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<? super X> consumer)

Specified by:

forEachFailed in interface Try<T,X extends java.lang.Throwable>

Parameters:

consumer - Accept value if Failure / not called on Failure

visit

public <R> R visit(java.util.function.Function<? super T,? extends R> success,
                   java.util.function.Function<? super X,? extends R> failure)

Specified by:

visit in interface Try<T,X extends java.lang.Throwable>