Try (Functional Extensions Library 4.5.1 API)

java.lang.Object
- io.atlassian.fugue.Try<A>

```
public abstract class Try<A>
extends Object
```
A Try represents a computation that may either throw an exception or return a value. A Try will either be Success wrapping a value or Failure which wraps an exception.
This class is similar to Either, but is explicit about having a success and failure case. Unless method level javadoc says otherwise, methods will not automatically catch exceptions thrown by function arguments. In particular map will not catch automatically catch thrown exceptions, instead you should use Checked.lift(io.atlassian.fugue.Checked.Function<A, B, E>) to to make the function explicitly return a Try and the use flatmap.

Since:

4.4.0

Constructor Summary

Constructors
Constructor and Description

Try()

Constructors
Constructor and Description
`Try()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static <A> Try<A>`	`failure(Exception e)` Creates a new failure
`abstract <B> Try<B>`	`flatMap(Function<? super A,Try<B>> f)` Binds the given function across the success value if it is one.
`static <A> Try<A>`	`flatten(Try<Try<A>> t)` Reduces a nested Try by a single level
`abstract <B> B`	`fold(Function<? super Exception,B> failureF, Function<A,B> successF)` Applies the function to the wrapped value, applying failureF it this is a Left and successF if this is a Right.
`abstract A`	`getOrElse(Supplier<A> s)` Returns the contained value if this is a success otherwise call the supplier and return its value.
`abstract boolean`	`isFailure()` Returns `true` if this failure, otherwise `false`
`abstract boolean`	`isSuccess()` Returns `true` if this success, otherwise `false`
`abstract <B> Try<B>`	`map(Function<? super A,? extends B> f)` Maps the given function to the value from this `Success` or returns this unchanged if a `Failure`.
`abstract <X extends Exception> Try<A>`	`recover(Class<X> exceptionType, Function<? super X,A> f)` Applies the given function `f` if this is a `Failure` with certain exception type otherwise leaves this unchanged.
`abstract Try<A>`	`recover(Function<? super Exception,A> f)` Applies the given function `f` if this is a `Failure` otherwise this unchanged if a 'Success'.
`abstract <X extends Exception> Try<A>`	`recoverWith(Class<X> exceptionType, Function<? super X,Try<A>> f)` Binds the given function across certain exception type if it is one, otherwise this unchanged.
`abstract Try<A>`	`recoverWith(Function<? super Exception,Try<A>> f)` Binds the given function across the failure value if it is one, otherwise this unchanged if a 'Success'.
`static <A> Try<Iterable<A>>`	`sequence(Iterable<Try<A>> trys)` Returns a success wrapping all of the values if all of the arguments were a success, otherwise this returns the first failure
`static <A> Try<A>`	`successful(A value)` Creates a new Success
`abstract Either<Exception,A>`	`toEither()` Convert this Try to an `Either`, becoming a left if this is a failure and a right if this is a success.
`abstract Option<A>`	`toOption()` Convert this Try to an Option.

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

- Constructor Detail
 - Try
```
public Try()
```
- Method Detail
 - failure
```
public static <A> Try<A> failure(Exception e)
```
 Creates a new failure
 
 Type Parameters:
 
 A - the success type
 
 Parameters:
 
 e - an exception to wrap, must not be null.
 
 Returns:
 
 a new Failure wrapping e.
 - successful
```
public static <A> Try<A> successful(A value)
```
 Creates a new Success
 
 Type Parameters:
 
 A - the wrapped value type
 
 Parameters:
 
 value - a value to wrap, must not be null
 
 Returns:
 
 a new Success wrapping v
 - sequence
```
public static <A> Try<Iterable<A>> sequence(Iterable<Try<A>> trys)
```
 Returns a success wrapping all of the values if all of the arguments were a success, otherwise this returns the first failure
 
 Type Parameters:
 
 A - The success type
 
 Parameters:
 
 trys - an iterable of try values
 
 Returns:
 
 a success wrapping all of the values if all of the arguments were a success, otherwise this returns the first failure
 - flatten
```
public static <A> Try<A> flatten(Try<Try<A>> t)
```
 Reduces a nested Try by a single level
 
 Type Parameters:
 
 A - The success type
 
 Parameters:
 
 t - A nested Try
 
 Returns:
 
 The flattened try
 - isFailure
```
public abstract boolean isFailure()
```
 Returns true if this failure, otherwise false
 
 Returns:
 
 true if this failure, otherwise false
 - isSuccess
```
public abstract boolean isSuccess()
```
 Returns true if this success, otherwise false
 
 Returns:
 
 true if this success, otherwise false
 - flatMap
```
public abstract  Try flatMap(Function<? super A,Try> f)
```
 Binds the given function across the success value if it is one.
 
 Type Parameters:
 
 B - result type
 
 Parameters:
 
 f - the function to bind.
 
 Returns:
 
 A new Try value after binding with the function applied if this is a Success, otherwise returns this if this is a `Failure`.
 - map
```
public abstract  Try map(Function<? super A,? extends B> f)
```
 Maps the given function to the value from this `Success` or returns this unchanged if a `Failure`.
 
 Type Parameters:
 
 B - result type
 
 Parameters:
 
 f - the function to apply
 
 Returns:
 
 `f` applied to the `Success`, otherwise returns this if this is a `Failure`.
 - recover
```
public abstract Try<A> recover(Function<? super Exception,A> f)
```
 Applies the given function `f` if this is a `Failure` otherwise this unchanged if a 'Success'. This is like map for the failure.
 
 Parameters:
 
 f - the function to apply
 
 Returns:
 
 `f` applied to the `Failure`, otherwise returns this if this is a `Success`.
 - recover
```
public abstract <X extends Exception> Try<A> recover(Class<X> exceptionType,
 Function<? super X,A> f)
```
 Applies the given function `f` if this is a `Failure` with certain exception type otherwise leaves this unchanged. This is like map for exceptions types.
 
 Type Parameters:
 
 X - exception type
 
 Parameters:
 
 exceptionType - exception class
 
 f - the function to apply
 
 Returns:
 
 `f` applied to the `Failure`, otherwise returns this if this is a `Success` or the exception does not match the exception type.
 - recoverWith
```
public abstract Try<A> recoverWith(Function<? super Exception,Try<A>> f)
```
 Binds the given function across the failure value if it is one, otherwise this unchanged if a 'Success'. This is like flatmap for the failure.
 
 Parameters:
 
 f - the function to bind.
 
 Returns:
 
 A new Try value after binding with the function applied if this is a `Failure`, otherwise returns this if this is a `Success`.
 - recoverWith
```
public abstract <X extends Exception> Try<A> recoverWith(Class<X> exceptionType,
 Function<? super X,Try<A>> f)
```
 Binds the given function across certain exception type if it is one, otherwise this unchanged. This is like flatmap for exceptions types.
 
 Type Parameters:
 
 X - exception type
 
 Parameters:
 
 exceptionType - exception class
 
 f - the function to apply
 
 Returns:
 
 A new Try value after binding with the function applied if this is a `Failure`, otherwise returns this if this is a `Success` or the exception does not match the exception type.
 - getOrElse
```
public abstract A getOrElse(Supplier<A> s)
```
 Returns the contained value if this is a success otherwise call the supplier and return its value.
 
 Parameters:
 
 s - called if this is a failure
 
 Returns:
 
 the wrapped value or the value from the Supplier
 - fold
```
public abstract  B fold(Function<? super Exception,B> failureF,
 Function<A,B> successF)
```
 Applies the function to the wrapped value, applying failureF it this is a Left and successF if this is a Right.
 
 Type Parameters:
 
 B - the destination type
 
 Parameters:
 
 failureF - the function to apply if this is a Failure
 
 successF - the function to apply if this is a Success
 
 Returns:
 
 the result of the applied function
 - toEither
```
public abstract Either<Exception,A> toEither()
```
 Convert this Try to an Either, becoming a left if this is a failure and a right if this is a success.
 
 Returns:
 
 this value wrapped in right if a success, and the exception wrapped in a left if a failure.
 - toOption
```
public abstract Option<A> toOption()
```
 Convert this Try to an Option. Returns Some with a value if it is a success, otherwise None.
 
 Returns:
 
 The success's value in Some if it exists, otherwise None

Class Try<A>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Try

Method Detail

failure

successful

sequence

flatten

isFailure

isSuccess

flatMap

map

recover

recover

recoverWith

recoverWith

getOrElse

fold

toEither

toOption