org.jdbi.v3.sqlobject.mixins

Interface GetHandle

public interface GetHandle

A mixin interface to define a method for obtaining the Handle attached to a sql object

Method Summary

Modifier and Type	Method and Description
Handle	getHandle() Obtain the handle associated to this sql object.
default <X extends Exception> void	useHandle(HandleConsumer<X> consumer) A convenience function which manages the lifecycle of the handle associated to this sql object, and yields it to a consumer for use by clients.
default <R,X extends Exception> R	withHandle(HandleCallback<R,X> callback) A convenience function which manages the lifecycle of the handle associated to this sql object, and yields it to a callback for use by clients.

Method Detail

getHandle

Handle getHandle()

Obtain the handle associated to this sql object.

Returns:

the handle

withHandle

default <R,X extends Exception> R withHandle(HandleCallback<R,X> callback)
                                      throws X extends Exception

A convenience function which manages the lifecycle of the handle associated to this sql object, and yields it to a callback for use by clients.

Type Parameters:

R - type returned by the callback

X - exception type thrown by the callback, if any.

Parameters:

callback - A callback which will receive the handle associated to this sql object

Returns:

the value returned by callback

Throws:

X - any exception thrown by the callback

X extends Exception

useHandle

default <X extends Exception> void useHandle(HandleConsumer<X> consumer)
                                      throws X extends Exception

A convenience function which manages the lifecycle of the handle associated to this sql object, and yields it to a consumer for use by clients.

Type Parameters:

X - exception type thrown by the callback, if any.

Parameters:

consumer - A consumer which will receive the handle associated to this sql object

Throws:

X - any exception thrown by the callback

X extends Exception