Try.Success (cyclops-react 1.0.0-FINAL API)

java.lang.Object
- com.aol.cyclops.control.Try.Success<T,X>

Type Parameters:

T - Success data type

X - Error data type

All Implemented Interfaces:

Try<T,X>, ApplicativeFunctor<T>, Convertable<T>, ConvertableFunctor<T>, Filterable<T>, Foldable<T>, Functor<T>, MonadicValue<T>, ConvertableToReactiveSeq<T>, ToStream<T>, Unit<T>, Value<T>, Visitable<T>, Zippable<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.Success<T,X extends java.lang.Throwable>
extends java.lang.Object
implements Try<T,X>
```
Class that represents a Successful 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.ApplicativeFunctor
  ApplicativeFunctor.Applicatives, ApplicativeFunctor.ApplyFunctions<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Value
  Value.ValueImpl<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Convertable
  Convertable.SupplierToConvertable<T>

Constructor Summary

Constructors
Constructor and Description

Success()

Constructors
Constructor and Description
`Success()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnyMValue<T>`	`anyM()`
`AnyM<X>`	`anyMFailure()`
`static <T,X extends java.lang.Throwable> AnyM<T>`	`anyMOf(T value)`
`static <T,X extends java.lang.Throwable> AnyM<T>`	`anyMOf(T value, java.lang.Class<? extends java.lang.Throwable>[] classes)`
`AnyM<T>`	`anyMSuccess()`
`<T2,R> Try<R,X>`	`combine(Value<? extends T2> app, java.util.function.BiFunction<? super T,? super T2,? extends R> fn)` Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction
`boolean`	`equals(java.lang.Object o)`
`X`	`failureGet()`
`Maybe<T>`	`filter(java.util.function.Predicate<? super T> p)` Keep only elements for which the supplied predicates hold e.g.
`<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()`
`int`	`hashCode()`
`boolean`	`isFailure()`
`boolean`	`isSuccess()`
`<R> Try<R,X>`	`map(java.util.function.Function<? super T,? extends R> fn)` Transform this functor using the supplied transformation function
`static <T,X extends java.lang.Throwable> Try.Success<T,X>`	`of(T value, java.lang.Class<? extends java.lang.Throwable>[] classes)` Return a Try that will catch specified exceptions when map / flatMap called For use with liftM / liftM2 and For Comprehensions (when Try is at the top level)
`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.Success<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.Success<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<T>`	`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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aol.cyclops.control.Try
cast, catchExceptions, coflatMap, combine, failure, filterNot, fromIterable, fromPublisher, fromPublisher, isPresent, iterator, matches, nest, notNull, ofType, patternMatch, peek, peekFailed, runWithCatch, success, toTry, toXorWithError, trampoline, unit, withCatch, zip, zip, zip, zip, zip, zip, zip

Methods inherited from interface com.aol.cyclops.types.stream.ToStream
futureStream, getStreamable, isEmpty, jdkStream, reactiveSeq, reveresedJDKStream, reveresedStream

Methods inherited from interface com.aol.cyclops.types.applicative.ApplicativeFunctor
applyFunctions

Methods inherited from interface com.aol.cyclops.types.Value
collect, fold, fold, generate, iterate, mapReduce, mkString, newSubscriber, of, subscribe, test, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFeatureToggle, toFutureStream, toFutureStream, toLazyImmutable, toList, toListX, toMaybe, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry, toXor

Methods inherited from interface com.aol.cyclops.types.Foldable
endsWith, endsWithIterable, findAny, findFirst, firstValue, foldable, foldRight, foldRight, foldRight, foldRightMapToType, get, groupBy, join, join, join, mapReduce, print, print, printErr, printOut, reduce, reduce, reduce, reduce, reduce, reduce, reduce, schedule, scheduleFixedDelay, scheduleFixedRate, single, single, singleOptional, startsWith, startsWithIterable, toConcurrentLazyCollection, toConcurrentLazyStreamable, toLazyCollection, validate, xMatch

Methods inherited from interface com.aol.cyclops.types.Convertable
collect, fromSupplier, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toFutureWAsync, toFutureWAsync, toOptionalAtomicReference, toStream, visit

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

Methods inherited from interface java.lang.Iterable
spliterator

- Constructor Detail
  - Success
```
public Success()
```
- Method Detail
  - unapply
```
public ListX<T> 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>
  - 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
  - anyM
```
public AnyMValue<T> anyM()
```
    Specified by:
    
    anyM in interface Try<T,X extends java.lang.Throwable>
    
    Specified by:
    
    anyM in interface MonadicValue<T>
    
    Returns:
    
    This monad wrapped as AnyM
  - anyMFailure
```
public 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 AnyM<T> anyMSuccess()
```
    Specified by:
    
    anyMSuccess in interface Try<T,X extends java.lang.Throwable>
    
    Returns:
    
    This monad, wrapped as AnyM of Success
  - anyMOf
```
public static <T,X extends java.lang.Throwable> AnyM<T> anyMOf(T value,
                                                               java.lang.Class<? extends java.lang.Throwable>[] classes)
```
    Parameters:
    
    value - Successful value
    
    Returns:
    
    new Success with value
  - anyMOf
```
public static <T,X extends java.lang.Throwable> AnyM<T> anyMOf(T value)
```
    Parameters:
    
    value - Successful value
    
    Returns:
    
    new Success with value
  - of
```
public static <T,X extends java.lang.Throwable> Try.Success<T,X> of(T value,
                                                                    java.lang.Class<? extends java.lang.Throwable>[] classes)
```
    Description copied from interface: Try
    
    Return a Try that will catch specified exceptions when map / flatMap called For use with liftM / liftM2 and For Comprehensions (when Try is at the top level)
    
    Specified by:
    
    of in interface Try<T,X extends java.lang.Throwable>
    
    Parameters:
    
    value - Successful value
    
    classes - Exceptions to catch during map / flatMap
    
    Returns:
    
    new Success with value
  - map
```
public <R> Try<R,X> map(java.util.function.Function<? super T,? extends R> fn)
```
    Description copied from interface: Functor
    Transform this functor using the supplied transformation function
```
  
  
  
    of(1,2,3).map(i->i*2)
    
    //[2,4,6]
  
 
 
```
    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>
    
    Specified by:
    
    map in interface MonadicValue<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)
```
    Description copied from interface: Filterable
    Keep only elements for which the supplied predicates hold e.g.
```
  
   
     of(1,2,3).filter(i->i>2);
     
     //[3]
   
 
 
```
    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
  - 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
  - recoverFor
```
public Try.Success<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
  - recoverWithFor
```
public Try.Success<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
  - 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
  - failureGet
```
public X failureGet()
```
    Specified by:
    
    failureGet in interface Try<T,X extends java.lang.Throwable>
  - 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
  - combine
```
public <T2,R> Try<R,X> combine(Value<? extends T2> app,
                               java.util.function.BiFunction<? super T,? super T2,? extends R> fn)
```
    Description copied from interface: ApplicativeFunctor
    
    Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction
    
    Specified by:
    
    combine in interface Try<T,X extends java.lang.Throwable>
    
    Specified by:
    
    combine in interface ApplicativeFunctor<T>
    
    Parameters:
    
    app - Value to combine with this one.
    
    fn - BiFunction to combine them
    
    Returns:
    
    New Applicativefunctor that represents the combined values
  - 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>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

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

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface java.lang.Iterable

Constructor Detail

Success

Method Detail

unapply

toXor

toIor

get

anyM

anyMFailure

anyMSuccess

anyMOf

anyMOf

of

map

flatMap

filter

recover

recoverWith

recoverFor

recoverWithFor

flatten

orElse

failureGet

orElseGet

toOptional

stream

isSuccess

isFailure

forEach

onFail

onFail

throwException

toFailedOptional

toFailedStream

forEachFailed

combine

visit

hashCode

equals