Try (funzy 0.1.0 API)

java.lang.Object
- org.jooby.funzy.Try

Direct Known Subclasses:

Try.Value
```
public abstract class Try
extends Object
```
Functional try and try-with-resources implementation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Try.ResourceHandler<R extends AutoCloseable>` Try with resource implementation.
`static class`	`Try.ResourceHandler2<R1 extends AutoCloseable,R2 extends AutoCloseable>` Try with resource implementation.
`static class`	`Try.ResourceHandler3<R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable>`
`static class`	`Try.ResourceHandler4<R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable,R4 extends AutoCloseable>`
`static class`	`Try.Value<V>` Try with a value.

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 <V> Try.Value<V>`	`apply(Throwing.Supplier<? extends V> fn)` Creates a new try from given value provider.
`static <V> Try.Value<V>`	`call(Callable<? extends V> fn)` Creates a new try from given callable.
`static Try.Value<Throwable>`	`failure(Throwable x)` Get a new failure value.
`abstract Optional<Throwable>`	`getCause()` Cause for failure or empty optional for success result.
`boolean`	`isFailure()` True in case of failure.
`boolean`	`isSuccess()` True in case of success.
`static <R extends AutoCloseable> Try.ResourceHandler<R>`	`of(R r1)` Functional try-with-resources:
`static <R1 extends AutoCloseable,R2 extends AutoCloseable> Try.ResourceHandler2<R1,R2>`	`of(R1 r1, R2 r2)` Functional try-with-resources:
`static <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable> Try.ResourceHandler3<R1,R2,R3>`	`of(R1 r1, R2 r2, R3 r3)` Functional try-with-resources with 3 inputs.
`static <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable,R4 extends AutoCloseable> Try.ResourceHandler4<R1,R2,R3,R4>`	`of(R1 r1, R2 r2, R3 r3, R4 r4)` Functional try-with-resources with 4 inputs.
`Try`	`onComplete(Throwing.Consumer<Throwable> action)` Always run the given action, works like a finally clause.
`Try`	`onComplete(Throwing.Runnable action)` Always run the given action, works like a finally clause.
`Try`	`onFailure(Consumer<? super Throwable> action)` Run the given action if and only if this is a failure.
`Try`	`onSuccess(Runnable action)` Run the given action if and only if this is a success.
`static Try`	`run(Throwing.Runnable runnable)` Creates a side effect try from given runnable.
`static <V> Try.Value<V>`	`success(V value)` Get a new success value.
`void`	`throwException()` Propagate/throw the exception in case of failure.
`<X extends Throwable> Try`	`unwrap(Class<? extends X> type)` In case of failure unwrap the exception provided by calling `Throwable.getCause()`.
`Try`	`unwrap(Throwing.Predicate<Throwable> predicate)` In case of failure unwrap the exception provided by calling `Throwable.getCause()`.
`static <R extends AutoCloseable> Try.ResourceHandler<R>`	`with(Throwing.Supplier<R> r1)` Functional try-with-resources:
`static <R1 extends AutoCloseable,R2 extends AutoCloseable> Try.ResourceHandler2<R1,R2>`	`with(Throwing.Supplier<R1> r1, Throwing.Supplier<R2> r2)` Functional try-with-resources:
`static <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable> Try.ResourceHandler3<R1,R2,R3>`	`with(Throwing.Supplier<R1> r1, Throwing.Supplier<R2> r2, Throwing.Supplier<R3> r3)` Functional try-with-resources with 3 inputs.
`static <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable,R4 extends AutoCloseable> Try.ResourceHandler4<R1,R2,R3,R4>`	`with(Throwing.Supplier<R1> r1, Throwing.Supplier<R2> r2, Throwing.Supplier<R3> r3, Throwing.Supplier<R4> r4)` Functional try-with-resources with 4 inputs.
`<X extends Throwable> Try`	`wrap(Class<? extends X> predicate, Throwing.Function<X,Throwable> wrapper)` In case of failure wrap an exception matching the given predicate to something else.
`Try`	`wrap(Throwing.Function<Throwable,Throwable> wrapper)` In case of failure wrap an exception matching the given predicate to something else.
`<X extends Throwable> Try`	`wrap(Throwing.Predicate<X> predicate, Throwing.Function<X,Throwable> wrapper)` In case of failure wrap an exception matching the given predicate to something else.

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

of

public static final <R extends AutoCloseable> Try.ResourceHandler<R> of(R r1)

Functional try-with-resources:


  InputStream in = ...;

  byte[] content = Try.of(in)
    .apply(in -> read(in))
    .get();

Jdbc example:


  Connection connection = ...;

  Try.of(connection)
     .map(c -> c.preparedStatement("..."))
     .map(stt -> stt.executeQuery())
     .apply(rs-> {
       return res.getString("column");
     })
     .get();

Type Parameters:: R - Resource type.
Parameters:: r1 - Input resource.
Returns:: A resource handler.

of

public static final <R1 extends AutoCloseable,R2 extends AutoCloseable> Try.ResourceHandler2<R1,R2> of(R1 r1,
                                                                                                       R2 r2)

Functional try-with-resources:


  InputStream in = ...;
  OutputStream out = ...;

  Try.of(in, out)
    .run((from, to) -> copy(from, to))
    .onFailure(Throwable::printStacktrace);

Type Parameters:: R1 - Resource type.; R2 - Resource type.
Parameters:: r1 - Input resource.; r2 - Input resource.
Returns:: A resource handler.

of

public static final <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable> Try.ResourceHandler3<R1,R2,R3> of(R1 r1,
                                                                                                                                   R2 r2,
                                                                                                                                   R3 r3)

Functional try-with-resources with 3 inputs.

Type Parameters:: R1 - Resource type.; R2 - Resource type.; R3 - Resource type.
Parameters:: r1 - Input resource.; r2 - Input resource.; r3 - Input resource.
Returns:: A resource handler.

of

public static final <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable,R4 extends AutoCloseable> Try.ResourceHandler4<R1,R2,R3,R4> of(R1 r1,
                                                                                                                                                               R2 r2,
                                                                                                                                                               R3 r3,
                                                                                                                                                               R4 r4)

Functional try-with-resources with 4 inputs.

Type Parameters:: R1 - Resource type.; R2 - Resource type.; R3 - Resource type.; R4 - Resource type.
Parameters:: r1 - Input resource.; r2 - Input resource.; r3 - Input resource.; r4 - Input resource.
Returns:: A resource handler.

with

public static final <R extends AutoCloseable> Try.ResourceHandler<R> with(Throwing.Supplier<R> r1)

Functional try-with-resources:


  byte[] content = Try.with(() -> newInputStream())
    .apply(in -> read(in))
    .get();

Jdbc example:


  Try.with(() -> newConnection())
     .map(c -> c.preparedStatement("..."))
     .map(stt -> stt.executeQuery())
     .apply(rs-> {
       return res.getString("column");
     })
     .get();

Type Parameters:: R - Resource type.
Parameters:: r1 - Input resource.
Returns:: A resource handler.

with

public static final <R1 extends AutoCloseable,R2 extends AutoCloseable> Try.ResourceHandler2<R1,R2> with(Throwing.Supplier<R1> r1,
                                                                                                         Throwing.Supplier<R2> r2)

Functional try-with-resources:


  Try.with(() -> newIn(), () -> newOut())
    .run((from, to) -> copy(from, to))
    .onFailure(Throwable::printStacktrace);

Type Parameters:: R1 - Resource type.; R2 - Resource type.
Parameters:: r1 - Input resource.; r2 - Input resource.
Returns:: A resource handler.

with

public static final <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable> Try.ResourceHandler3<R1,R2,R3> with(Throwing.Supplier<R1> r1,
                                                                                                                                     Throwing.Supplier<R2> r2,
                                                                                                                                     Throwing.Supplier<R3> r3)

Functional try-with-resources with 3 inputs.

Type Parameters:: R1 - Resource type.; R2 - Resource type.; R3 - Resource type.
Parameters:: r1 - Input resource.; r2 - Input resource.; r3 - Input resource.
Returns:: A resource handler.

with

public static final <R1 extends AutoCloseable,R2 extends AutoCloseable,R3 extends AutoCloseable,R4 extends AutoCloseable> Try.ResourceHandler4<R1,R2,R3,R4> with(Throwing.Supplier<R1> r1,
                                                                                                                                                                 Throwing.Supplier<R2> r2,
                                                                                                                                                                 Throwing.Supplier<R3> r3,
                                                                                                                                                                 Throwing.Supplier<R4> r4)

Functional try-with-resources with 4 inputs.

Type Parameters:: R1 - Resource type.; R2 - Resource type.; R3 - Resource type.; R4 - Resource type.
Parameters:: r1 - Input resource.; r2 - Input resource.; r3 - Input resource.; r4 - Input resource.
Returns:: A resource handler.

success
```
public static final <V> Try.Value<V> success(V value)
```
Get a new success value.

Type Parameters:

V - Value type.

Parameters:

value - Value.

Returns:

A new success value.

failure
```
public static final Try.Value<Throwable> failure(Throwable x)
```
Get a new failure value.

Parameters:

x - Exception.

Returns:

A new failure value.

apply
```
public static <V> Try.Value<V> apply(Throwing.Supplier<? extends V> fn)
```
Creates a new try from given value provider.

Type Parameters:

V - Value type.

Parameters:

fn - Value provider.

Returns:

A new success try or failure try in case of exception.

call
```
public static <V> Try.Value<V> call(Callable<? extends V> fn)
```
Creates a new try from given callable.

Type Parameters:

V - Value type.

Parameters:

fn - Callable.

Returns:

A new success try or failure try in case of exception.

run
```
public static Try run(Throwing.Runnable runnable)
```
Creates a side effect try from given runnable. Don't forget to either throw or log the exception in case of failure. Unless, of course you don't care about the exception. Log the exception:
```
   Try.run(() -> ...)
     .onFailure(x -> x.printStacktrace());
 
```
Throw the exception:
```
   Try.run(() -> ...)
     .throwException();
 
```
Parameters:

runnable - Runnable.

Returns:

A void try.

isFailure
```
public boolean isFailure()
```
True in case of failure.

Returns:

True in case of failure.

isSuccess
```
public boolean isSuccess()
```
True in case of success.

Returns:

True in case of success.

onFailure
```
public Try onFailure(Consumer<? super Throwable> action)
```
Run the given action if and only if this is a failure.

Parameters:

action - Failure listener.

Returns:

This try.

onSuccess
```
public Try onSuccess(Runnable action)
```
Run the given action if and only if this is a success.

Parameters:

action - Success listener.

Returns:

This try.

unwrap
```
public <X extends Throwable> Try unwrap(Class<? extends X> type)
```
In case of failure unwrap the exception provided by calling Throwable.getCause(). Useful for clean/shorter stackstrace. Example for InvocationTargetException:
```
 Try.run(() -> {
   Method m = ...;
   m.invoke(...); //might throw InvocationTargetException
 }).unwrap(InvocationTargetException.class)
   .throwException();
 
```
Type Parameters:

X - Exception type.

Parameters:

type - Exception filter.

Returns:

This try for success or a new failure with exception unwrap.

unwrap
```
public Try unwrap(Throwing.Predicate<Throwable> predicate)
```
In case of failure unwrap the exception provided by calling Throwable.getCause(). Useful for clean/shorter stackstrace. Example for InvocationTargetException:
```
 Try.run(() -> {
   Method m = ...;
   m.invoke(...); //might throw InvocationTargetException
 }).unwrap(InvocationTargetException.class::isInstance)
   .throwException();
 
```
Parameters:

predicate - Exception filter.

Returns:

This try for success or a new failure with exception unwrap.

wrap
```
public Try wrap(Throwing.Function<Throwable,Throwable> wrapper)
```
In case of failure wrap an exception matching the given predicate to something else.

Parameters:

wrapper - Exception mapper.

Returns:

This try for success or a new failure with exception wrapped.

wrap
```
public <X extends Throwable> Try wrap(Class<? extends X> predicate,
                                      Throwing.Function<X,Throwable> wrapper)
```
In case of failure wrap an exception matching the given predicate to something else.

Type Parameters:

X - Exception type.

Parameters:

predicate - Exception predicate.

wrapper - Exception mapper.

Returns:

This try for success or a new failure with exception wrapped.

wrap
```
public <X extends Throwable> Try wrap(Throwing.Predicate<X> predicate,
                                      Throwing.Function<X,Throwable> wrapper)
```
In case of failure wrap an exception matching the given predicate to something else.

Type Parameters:

X - Exception type.

Parameters:

predicate - Exception predicate.

wrapper - Exception mapper.

Returns:

This try for success or a new failure with exception wrapped.

onComplete
```
public Try onComplete(Throwing.Runnable action)
```
Always run the given action, works like a finally clause.

Parameters:

action - Finally action.

Returns:

This try result.

onComplete
```
public Try onComplete(Throwing.Consumer<Throwable> action)
```
Always run the given action, works like a finally clause. Exception will be null in case of success.

Parameters:

action - Finally action.

Returns:

This try result.

throwException
```
public void throwException()
```
Propagate/throw the exception in case of failure.

getCause
```
public abstract Optional<Throwable> getCause()
```
Cause for failure or empty optional for success result.

Returns:

Cause for failure or empty optional for success result.

Class Try

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Try

Method Detail

of

of

of

of

with

with

with

with

success

failure

apply

call

run

isFailure

isSuccess

onFailure

onSuccess

unwrap

unwrap

wrap

wrap

wrap

onComplete

onComplete

throwException

getCause