Module io.helidon.integrations.jdbc

Package io.helidon.integrations.jdbc

Class ConditionallyCloseableConnection

java.lang.Object

io.helidon.integrations.jdbc.DelegatingConnection

io.helidon.integrations.jdbc.ConditionallyCloseableConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

public class ConditionallyCloseableConnection
extends DelegatingConnection

A DelegatingConnection whose close() method performs a close only if the isCloseable() method returns true.

Thread Safety

Instances of this class are not necessarily safe for concurrent use by multiple threads.

See Also:

isCloseable(), setCloseable(boolean), close()

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor	Description
ConditionallyCloseableConnection(Connection delegate)	Creates a new ConditionallyCloseableConnection and sets its closeable status to true.
ConditionallyCloseableConnection(Connection delegate, boolean closeable)	Creates a new ConditionallyCloseableConnection.

Method Summary

Modifier and Type	Method	Description
void	close()	Overrides the DelegatingConnection.close() method so that when it is invoked this ConditionallyCloseableConnection is closed only if it is closeable.
boolean	isCloseable()	Returns true if a call to close() will actually close this ConditionallyCloseableConnection.
void	setCloseable(boolean closeable)	Sets the closeable status of this ConditionallyCloseableConnection.

Methods inherited from class io.helidon.integrations.jdbc.DelegatingConnection

abort, beginRequest, clearWarnings, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, endRequest, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, isWrapperFor, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid, setTransactionIsolation, setTypeMap, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionallyCloseableConnection

public ConditionallyCloseableConnection(Connection delegate)

Creates a new ConditionallyCloseableConnection and sets its closeable status to true.

Parameters:

delegate - the Connection to wrap; must not be null

Throws:

NullPointerException - if delegate is null

See Also:

ConditionallyCloseableConnection(Connection, boolean), setCloseable(boolean)

ConditionallyCloseableConnection

public ConditionallyCloseableConnection(Connection delegate,
                                        boolean closeable)

Creates a new ConditionallyCloseableConnection.

Parameters:

delegate - the Connection to wrap; must not be null

closeable - the initial value for this ConditionallyCloseableConnection's closeable status

Throws:

NullPointerException - if delegate is null

See Also:

setCloseable(boolean), DelegatingConnection(Connection)

Method Detail

close

public void close()
           throws SQLException

Overrides the DelegatingConnection.close() method so that when it is invoked this ConditionallyCloseableConnection is closed only if it is closeable.

Overrides should normally call super.close() as part of their implementation.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Overrides:

close in class DelegatingConnection

Throws:

SQLException - if an error occurs

See Also:

isCloseable()

isCloseable

public final boolean isCloseable()
                          throws SQLException

Returns true if a call to close() will actually close this ConditionallyCloseableConnection.

This method returns true when setCloseable(boolean) has been called with a value of true and the DelegatingConnection.isClosed() method returns false.

Returns:

true if a call to close() will actually close this ConditionallyCloseableConnection; false in all other cases

Throws:

SQLException - if DelegatingConnection.isClosed() throws a SQLException

See Also:

setCloseable(boolean), close(), DelegatingConnection.isClosed()

setCloseable

public final void setCloseable(boolean closeable)

Sets the closeable status of this ConditionallyCloseableConnection.

Note that calling this method with a value of true does not necessarily mean that the isCloseable() method will subsequently return true, since the DelegatingConnection.isClosed() method may return true.

Parameters:

closeable - whether or not a call to close() will actually close this ConditionallyCloseableConnection

See Also:

isCloseable(), close(), Connection.close(), DelegatingConnection.isClosed()