Try (simple-react 1.0.0-RC2.1 API)

Type Parameters:

T - Return type (success)

X - Base Error type

All Superinterfaces:

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

All Known Implementing Classes:

Try.Failure, Try.Success
```
public interface Try<T,X extends java.lang.Throwable>
extends java.util.function.Supplier<T>, Value<T>, ToStream<T>, Filterable<T>, Functor<T>, Applicativable<T>
```
Light weight Try Monad Fail fast behaviour with more explicit declararions required compared to with scala.util.Try and javaslang.monad.Try. This is probably closer to how most Java devs currently handle exceptions. Goals / features Support for init block / try block / finally block Try with resources Try with multiple resources Does not automatically catch exceptions in combinators Can target specific exception types Exception types to be caught can be specified in xxxWithCatch methods Handle exceptions conciously, not coding bugs Fluent step builders Fail fast

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Try.AndFinally<T,V,X extends java.lang.Throwable>`
`static interface`	`Try.CheckedConsumer<T,X extends java.lang.Throwable>`
`static interface`	`Try.CheckedFunction<T,R,X extends java.lang.Throwable>`
`static interface`	`Try.CheckedRunnable<X extends java.lang.Throwable>`
`static interface`	`Try.CheckedSupplier<T,X extends java.lang.Throwable>`
`static class`	`Try.Failure<T,X extends java.lang.Throwable>` Class that represents the Failure of a Try
`static interface`	`Try.Init<X extends java.lang.Throwable>`
`static class`	`Try.MyFinallyBlock<T,V,X extends java.lang.Throwable>`
`static class`	`Try.MyInit<X extends java.lang.Throwable>`
`static class`	`Try.MyTryCatch<V,X extends java.lang.Throwable>`
`static class`	`Try.Success<T,X extends java.lang.Throwable>` Class that represents a Successful Try
`static interface`	`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>

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`AnyM<T>`	`anyM()`
`AnyM<X>`	`anyMFailure()`
`AnyM<T>`	`anyMSuccess()`
`default <U> Try<U,X>`	`cast(java.lang.Class<U> type)` Cast all elements in a stream to a given type, possibly throwing a `ClassCastException`.
`static <X extends java.lang.Throwable> Try.Init<X>`	`catchExceptions(java.lang.Class<? extends X>... classes)` Fluent step builder for Try / Catch / Finally and Try with resources equivalents.
`static <T,X extends java.lang.Throwable> Try.Failure<T,X>`	`failure(X error)` Construct a Failure instance from a throwable
`X`	`failureGet()`
`Maybe<T>`	`filter(java.util.function.Predicate<? super T> p)`
`default Maybe<T>`	`filterNot(java.util.function.Predicate<? super T> fn)`
`<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()`
`default java.util.Iterator<T>`	`iterator()`
`<R> Try<R,X>`	`map(java.util.function.Function<? super T,? extends R> fn)`
`default <R> Eval<R>`	`matches(java.util.function.Function<Matchable.CheckValue1<T,R>,Matchable.CheckValue1<T,R>> secondary, java.util.function.Function<Matchable.CheckValue1<X,R>,Matchable.CheckValue1<X,R>> primary, java.util.function.Supplier<? extends R> otherwise)`
`default Maybe<T>`	`notNull()`
`static <T,X extends java.lang.Throwable> Try<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)
`default <U> Maybe<U>`	`ofType(java.lang.Class<U> type)` Keep only those elements in a stream that are of a given type.
`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)`
`default <R> Try<R,X>`	`patternMatch(java.util.function.Function<Matchable.CheckValues<T,R>,Matchable.CheckValues<T,R>> case1, java.util.function.Supplier<? extends R> otherwise)` Transform the elements of this Stream with a Pattern Matching case and default value
`default Try<T,X>`	`peek(java.util.function.Consumer<? super T> consumer)`
`default Try<T,X>`	`peekFailed(java.util.function.Consumer<? super X> consumer)`
`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
`static <X extends java.lang.Throwable> Try<java.lang.Void,X>`	`runWithCatch(Try.CheckedRunnable<X> cf, java.lang.Class<? extends X>... classes)` Try to execute supplied Runnable and will Catch specified Excpetions or java.lang.Exception if none specified.
`ReactiveSeq<T>`	`stream()`
`static <T,X extends java.lang.Throwable> Try.Success<T,X>`	`success(T value)`
`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()`
`default Xor<X,T>`	`toXorWithError()`
`default <R> Try<R,X>`	`trampoline(java.util.function.Function<? super T,? extends Trampoline<? extends R>> mapper)` Performs a map operation that can call a recursive method without running out of stack space
`default <T> Try<T,?>`	`unit(T value)`
`<R> R`	`visit(java.util.function.Function<? super T,? extends R> success, java.util.function.Function<? super X,? extends R> failure)`
`static <T,X extends java.lang.Throwable> Try<T,X>`	`withCatch(Try.CheckedSupplier<T,X> cf, java.lang.Class<? extends X>... classes)` Try to execute supplied Supplier and will Catch specified Excpetions or java.lang.Exception if none specified.

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, mkString, newSubscriber, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFutureStream, toFutureStream, toLazyImmutable, toListX, toMaybe, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry, unapply

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

- Method Detail
 - matches
```
default <R> Eval<R> matches(java.util.function.Function<Matchable.CheckValue1<T,R>,Matchable.CheckValue1<T,R>> secondary,
 java.util.function.Function<Matchable.CheckValue1<X,R>,Matchable.CheckValue1<X,R>> primary,
 java.util.function.Supplier<? extends R> otherwise)
```
 - failureGet
```
X failureGet()
```
 - toXor
```
Xor<X,T> toXor()
```
 Specified by:
 
 toXor in interface Value<T>
 - toIor
```
Ior<X,T> toIor()
```
 Specified by:
 
 toIor in interface Value<T>
 - cast
```
default  Try<U,X> cast(java.lang.Class type)
```
 Description copied from interface: Functor
 
 Cast all elements in a stream to a given type, possibly throwing a ClassCastException. // ClassCastException ReactiveSeq.of(1, "a", 2, "b", 3).cast(Integer.class)
 
 Specified by:
 
 cast in interface Functor<T>
 - trampoline
```
default <R> Try<R,X> trampoline(java.util.function.Function<? super T,? extends Trampoline<? extends R>> mapper)
```
 Description copied from interface: Functor
 Performs a map operation that can call a recursive method without running out of stack space
```
 
 ReactiveSeq.of(10,20,30,40)
				 .trampoline(i-> fibonacci(i))
				 .forEach(System.out::println); 
				 
		Trampoline<Long> fibonacci(int i){
			return fibonacci(i,1,0);
		}
		Trampoline<Long> fibonacci(int n, long a, long b) {
	 	return n == 0 ? Trampoline.done(b) : Trampoline.more( ()->fibonacci(n-1, a+b, a));
		}		 
				 
 55
		6765
		832040
		102334155
 
 
 ReactiveSeq.of(10_000,200_000,3_000_000,40_000_000)
				 .trampoline(i-> fibonacci(i))
				 .forEach(System.out::println);
				 
				 
 completes successfully
 
 
```
 Specified by:
 
 trampoline in interface Functor<T>
 
 Returns:
 - ofType
```
default  Maybe ofType(java.lang.Class type)
```
 Description copied from interface: Filterable
 
 Keep only those elements in a stream that are of a given type. // (1, 2, 3) ReactiveSeq.of(1, "a", 2, "b",3).ofType(Integer.class)
 
 Specified by:
 
 ofType in interface Filterable<T>
 - filterNot
```
default Maybe<T> filterNot(java.util.function.Predicate<? super T> fn)
```
 Specified by:
 
 filterNot in interface Filterable<T>
 - notNull
```
default Maybe<T> notNull()
```
 Specified by:
 
 notNull in interface Filterable<T>
 - failure
```
static <T,X extends java.lang.Throwable> Try.Failure<T,X> failure(X error)
```
 Construct a Failure instance from a throwable
 
 Parameters:
 
 error - for Failure
 
 Returns:
 
 new Failure with error
 - success
```
static <T,X extends java.lang.Throwable> Try.Success<T,X> success(T value)
```
 Parameters:
 
 value - Successful value
 
 Returns:
 
 new Success with value
 - toXorWithError
```
default Xor<X,T> toXorWithError()
```
 - unit
```
default <T> Try<T,?> unit(T value)
```
 Specified by:
 
 unit in interface Unit<T>
 - patternMatch
```
default <R> Try<R,X> patternMatch(java.util.function.Function<Matchable.CheckValues<T,R>,Matchable.CheckValues<T,R>> case1,
 java.util.function.Supplier<? extends R> otherwise)
```
 Description copied from interface: Functor
 Transform the elements of this Stream with a Pattern Matching case and default value
```
 
 List<String> result = CollectionX.of(1,2,3,4)
 .patternMatch(
 c->c.valuesWhere(i->"even", (Integer i)->i%2==0 )
 )
 
 // CollectionX["odd","even","odd","even"]
 
```
 Specified by:
 
 patternMatch in interface Functor<T>
 
 Parameters:
 
 case1 - Function to generate a case (or chain of cases as a single case)
 
 otherwise - Value if supplied case doesn't match
 
 Returns:
 
 CollectionX where elements are transformed by pattern matching
 - visit
```
<R> R visit(java.util.function.Function<? super T,? extends R> success,
 java.util.function.Function<? super X,? extends R> failure)
```
 - anyM
```
AnyM<T> anyM()
```
 Returns:
 
 This monad, wrapped as AnyM of Success
 - anyMFailure
```
AnyM<X> anyMFailure()
```
 Returns:
 
 This monad, wrapped as AnyM of Failure
 - anyMSuccess
```
AnyM<T> anyMSuccess()
```
 Returns:
 
 This monad, wrapped as AnyM of Success
 - get
```
T get()
```
 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
 - throwException
```
void throwException()
```
 Throw exception if Failure, do nothing if success
 - orElse
```
T orElse(T value)
```
 Description copied from interface: Convertable
 
 Get the contained value or else the provided alternative
 
 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
```
T orElseGet(java.util.function.Supplier<? extends T> value)
```
 Specified by:
 
 orElseGet in interface Convertable<T>
 
 Parameters:
 
 value - from supplied Supplier if Failure otherwise return Success value
 
 Returns:
 
 Success value
 - map
```
<R> Try<R,X> map(java.util.function.Function<? super T,? extends R> fn)
```
 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
```
<R> Try<R,X> flatMap(java.util.function.Function<? super T,? extends Try<R,X>> fn)
```
 Parameters:
 
 fn - FlatMap success value or Do nothing if Failure (return this)
 
 Returns:
 
 Try returned from FlatMap fn
 - filter
```
Maybe<T> filter(java.util.function.Predicate<? super T> p)
```
 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
 - onFail
```
Try<T,X> onFail(java.util.function.Consumer<? super X> consumer)
```
 Parameters:
 
 consumer - Accept Exception if present (Failure)
 
 Returns:
 
 this
 - onFail
```
Try<T,X> onFail(java.lang.Class<? extends X> t,
 java.util.function.Consumer<X> consumer)
```
 Parameters:
 
 t - Class type of match Exception against
 
 consumer - Accept Exception if present (Failure) and if class types match
 
 Returns:
 
 this
 - recover
```
Try.Success<T,X> recover(java.util.function.Function<? super X,? extends T> fn)
```
 Parameters:
 
 fn - Recovery function - map from a failure to a Success.
 
 Returns:
 
 new Success
 - recoverWith
```
Try.Success<T,X> recoverWith(java.util.function.Function<? super X,? extends Try.Success<T,X>> fn)
```
 flatMap recovery
 
 Parameters:
 
 fn - Recovery FlatMap function. Map from a failure to a Success
 
 Returns:
 
 Success from recovery function
 - recoverFor
```
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
 
 Parameters:
 
 t - Type of exception to match against
 
 fn - Recovery function
 
 Returns:
 
 New Success if failure and types match / otherwise this
 - recoverWithFor
```
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
 
 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
```
Try<T,X> flatten()
```
 Flatten a nested Try Structure
 
 Returns:
 
 Lowest nested Try
 - toOptional
```
java.util.Optional<T> toOptional()
```
 Specified by:
 
 toOptional in interface Convertable<T>
 
 Returns:
 
 Optional present if Success, Optional empty if failure
 - stream
```
ReactiveSeq<T> stream()
```
 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
 - toFailedOptional
```
java.util.Optional<X> toFailedOptional()
```
 Returns:
 
 Optional present if Failure (with Exception), Optional empty if Success
 - toFailedStream
```
java.util.stream.Stream<X> toFailedStream()
```
 Returns:
 
 Stream with error if Failure, Empty Stream if success
 - isSuccess
```
boolean isSuccess()
```
 Returns:
 
 true if Success / false if Failure
 - isFailure
```
boolean isFailure()
```
 Returns:
 
 True if Failure / false if Success
 - forEach
```
void forEach(java.util.function.Consumer<? super T> consumer)
```
 Specified by:
 
 forEach in interface java.lang.Iterable<T>
 
 Parameters:
 
 consumer - Accept value if Success / not called on Failure
 - forEachFailed
```
void forEachFailed(java.util.function.Consumer<? super X> consumer)
```
 Parameters:
 
 consumer - Accept value if Failure / not called on Failure
 - peek
```
default Try<T,X> peek(java.util.function.Consumer<? super T> consumer)
```
 Specified by:
 
 peek in interface Functor<T>
 
 Parameters:
 
 consumer - Accept value if Success
 
 Returns:
 
 this
 - peekFailed
```
default Try<T,X> peekFailed(java.util.function.Consumer<? super X> consumer)
```
 Parameters:
 
 consumer - Accept Exception if Failure
 
 Returns:
 
 this
 - iterator
```
default java.util.Iterator<T> iterator()
```
 Specified by:
 
 iterator in interface Convertable<T>
 
 Specified by:
 
 iterator in interface java.lang.Iterable<T>
 
 Specified by:
 
 iterator in interface ToStream<T>
 - of
```
@SafeVarargs
static <T,X extends java.lang.Throwable> Try<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)
 
 Parameters:
 
 value - Initial value
 
 classes - Exceptions to catch during map / flatMap
 
 Returns:
 
 Try instance
 - withCatch
```
@SafeVarargs
static <T,X extends java.lang.Throwable> Try<T,X> withCatch(Try.CheckedSupplier<T,X> cf,
 java.lang.Class<? extends X>... classes)
```
 Try to execute supplied Supplier and will Catch specified Excpetions or java.lang.Exception if none specified.
 
 Parameters:
 
 cf - CheckedSupplier to attempt to execute
 
 classes - Exception types to catch (or java.lang.Exception if none specified)
 
 Returns:
 
 New Try
 - runWithCatch
```
@SafeVarargs
static <X extends java.lang.Throwable> Try<java.lang.Void,X> runWithCatch(Try.CheckedRunnable<X> cf,
 java.lang.Class<? extends X>... classes)
```
 Try to execute supplied Runnable and will Catch specified Excpetions or java.lang.Exception if none specified.
 
 Parameters:
 
 cf - CheckedRunnable to attempt to execute
 
 classes - Exception types to catch (or java.lang.Exception if none specified)
 
 Returns:
 
 New Try
 - catchExceptions
```
@SafeVarargs
static <X extends java.lang.Throwable> Try.Init<X> catchExceptions(java.lang.Class<? extends X>... classes)
```
 Fluent step builder for Try / Catch / Finally and Try with resources equivalents. Start with Exception types to catch.
 
 Parameters:
 
 classes - Exception types to catch
 
 Returns:
 
 Next step in the fluent Step Builder

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

Nested Class Summary

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

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

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

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

Method Summary

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

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

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

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

Methods inherited from interface java.util.function.Predicate

Method Detail

matches

failureGet

toXor

toIor

cast

trampoline

ofType

filterNot

notNull

failure

success

toXorWithError

unit

patternMatch

visit

anyM

anyMFailure

anyMSuccess

get

throwException

orElse

orElseGet

map

flatMap

filter

onFail

onFail

recover

recoverWith

recoverFor

recoverWithFor

flatten

toOptional

stream

toFailedOptional

toFailedStream

isSuccess

isFailure

forEach

forEachFailed

peek

peekFailed

iterator

of

withCatch

runWithCatch

catchExceptions