Package com.jnape.palatable.lambda.functions.builtin.fn2

Class AutoBracket<A extends java.lang.AutoCloseable,B>

java.lang.Object

com.jnape.palatable.lambda.functions.builtin.fn2.AutoBracket<A,B>

Type Parameters:

A - the initial AutoCloseable value type to map and clean up

B - the resulting type

All Implemented Interfaces:

Fn1<IO<A>,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>>, Fn2<IO<A>,Fn1<? super A,? extends IO<B>>,IO<B>>, Applicative<Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<IO<A>,?>>, Cartesian<IO<A>,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<?,?>>, Cocartesian<IO<A>,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<?,?>>, Contravariant<IO<A>,Profunctor<?,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<?,?>>>, Functor<Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<IO<A>,?>>, Profunctor<IO<A>,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<?,?>>, Monad<Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<IO<A>,?>>, MonadReader<IO<A>,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<IO<A>,?>>, MonadRec<Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<IO<A>,?>>, MonadWriter<IO<A>,Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>,Fn1<IO<A>,?>>

public final class AutoBracket<A extends java.lang.AutoCloseable,B>
extends java.lang.Object
implements Fn2<IO<A>,Fn1<? super A,? extends IO<B>>,IO<B>>

Given an IO yielding some AutoCloseable type A and a kleisli arrow from that type to a new IO of type B, attempt to provision the A, applying the body operation if provisioning was successful and ensuring that AutoCloseable.close() is called regardless of whether the body succeeds or fails.

This is the canonical bracketing operation for AutoCloseables.

See Also:

Bracket

Field Summary

Fields

Modifier and Type	Field	Description
private static AutoBracket<?,?>	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AutoBracket()

Method Summary

Modifier and Type	Method	Description
static <A extends java.lang.AutoCloseable,B> AutoBracket<A,B>	autoBracket()
static <A extends java.lang.AutoCloseable,B> Fn1<Fn1<? super A,? extends IO<B>>,IO<B>>	autoBracket(IO<A> io)
static <A extends java.lang.AutoCloseable,B> IO<B>	autoBracket(IO<A> io, Fn1<? super A,? extends IO<B>> bodyIO)
IO<B>	checkedApply(IO<A> io, Fn1<? super A,? extends IO<B>> bodyIO)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn1

andThen, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, zip, zip

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn2

apply, apply, checkedApply, compose, contraMap, diMapL, discardR, flip, toBiFunction, uncurry, widen

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor

coerce

Field Detail

INSTANCE

private static final AutoBracket<?,?> INSTANCE

Constructor Detail

AutoBracket

private AutoBracket()

Method Detail

checkedApply

public IO<B> checkedApply(IO<A> io,
                          Fn1<? super A,? extends IO<B>> bodyIO)

Specified by:

checkedApply in interface Fn2<IO<A extends java.lang.AutoCloseable>,Fn1<? super A extends java.lang.AutoCloseable,? extends IO<B>>,IO<B>>

autoBracket

public static <A extends java.lang.AutoCloseable,B> AutoBracket<A,B> autoBracket()

autoBracket

public static <A extends java.lang.AutoCloseable,B> Fn1<Fn1<? super A,? extends IO<B>>,IO<B>> autoBracket(IO<A> io)

autoBracket

public static <A extends java.lang.AutoCloseable,B> IO<B> autoBracket(IO<A> io,
                                                                            Fn1<? super A,? extends IO<B>> bodyIO)