Package org.jdbi.v3.core.statement

Interface Cleanable

All Superinterfaces:

AutoCloseable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Cleanable
extends AutoCloseable

Cleans up some JDBC resource e.g. after completing execution of a SQL statement. Arguments, mappers, and other Jdbi interface implementations that allocate database resources should register a Cleanable to ensure that resources are freed after database operations are completed.

See Also:

• Handle.addCleanable(Cleanable)
• StatementContext.addCleanable(Cleanable)

Field Summary

Fields

Modifier and Type	Field	Description
static final Cleanable	NO_OP	A cleanable that does nothing.

Method Summary

Modifier and Type	Method	Description
void	close()
default void	closeAndSuppress(Throwable t)	Cleans the underlying resource and appends possible exceptions to the given Throwable.

Field Details

NO_OP

static final Cleanable NO_OP

A cleanable that does nothing.

Since:

3.43.0

Method Details

close

void close()
    throws SQLException

Specified by:

close in interface AutoCloseable

Throws:

SQLException

closeAndSuppress

default void closeAndSuppress(Throwable t)

Cleans the underlying resource and appends possible exceptions to the given Throwable.

Parameters:

t - A Throwable. Must not be null.