Module io.helidon.integrations.jdbc

Package io.helidon.integrations.jdbc

Class DelegatingStatement<S extends Statement>

java.lang.Object

io.helidon.integrations.jdbc.DelegatingStatement<S>

Type Parameters:

S - the type of the Statement subclass

All Implemented Interfaces:

AutoCloseable, Statement, Wrapper

Direct Known Subclasses:

DelegatingPreparedStatement

public class DelegatingStatement<S extends Statement>
extends Object
implements Statement

A JDBC 4.3-compliant Statement that delegates to another JDBC 4.3-compliant Statement.

Field Summary

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

Constructors

Constructor	Description
DelegatingStatement(Connection connection, S delegate, boolean closeable, boolean strictClosedChecking)	Creates a new DelegatingStatement.

Method Summary

Modifier and Type	Method	Description
void	addBatch(String sql)
void	cancel()
protected final void	checkOpen()	Ensures this DelegatingStatement is not closed, if strict closed checking was enabled at construction time.
void	clearBatch()
void	clearWarnings()
void	close()	Overrides the Statement.close() method so that when it is invoked this DelegatingStatement is closed only if it is closeable.
void	closeOnCompletion()
protected final S	delegate()	Returns the Statement to which all operations will be delegated.
String	enquoteIdentifier(String identifier, boolean alwaysQuote)
String	enquoteLiteral(String val)
String	enquoteNCharLiteral(String val)
boolean	execute(String sql)
boolean	execute(String sql, int autoGeneratedKeys)
boolean	execute(String sql, int[] columnIndexes)
boolean	execute(String sql, String[] columnNames)
int[]	executeBatch()
long[]	executeLargeBatch()
long	executeLargeUpdate(String sql)
long	executeLargeUpdate(String sql, int autoGeneratedKeys)
long	executeLargeUpdate(String sql, int[] columnIndexes)
long	executeLargeUpdate(String sql, String[] columnNames)
ResultSet	executeQuery(String sql)
int	executeUpdate(String sql)
int	executeUpdate(String sql, int autoGeneratedKeys)
int	executeUpdate(String sql, int[] columnIndexes)
int	executeUpdate(String sql, String[] columnNames)
Connection	getConnection()	Returns the Connection supplied at construction time.
int	getFetchDirection()
int	getFetchSize()
ResultSet	getGeneratedKeys()
long	getLargeMaxRows()
long	getLargeUpdateCount()
int	getMaxFieldSize()
int	getMaxRows()
boolean	getMoreResults()
boolean	getMoreResults(int current)
int	getQueryTimeout()
ResultSet	getResultSet()
int	getResultSetConcurrency()
int	getResultSetHoldability()
int	getResultSetType()
int	getUpdateCount()
SQLWarning	getWarnings()
boolean	isCloseable()	Returns true if a call to close() will actually close this DelegatingStatement.
boolean	isClosed()
boolean	isCloseOnCompletion()
boolean	isPoolable()
boolean	isSimpleIdentifier(String identifier)
boolean	isWrapperFor(Class<?> iface)
void	setCloseable(boolean closeable)	Sets the closeable status of this DelegatingStatement.
void	setCursorName(String name)
void	setEscapeProcessing(boolean enable)
void	setFetchDirection(int direction)
void	setFetchSize(int rows)
void	setLargeMaxRows(long max)
void	setMaxFieldSize(int max)
void	setMaxRows(int max)
void	setPoolable(boolean poolable)
void	setQueryTimeout(int seconds)
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingStatement

public DelegatingStatement(Connection connection,
 S delegate,
 boolean closeable,
 boolean strictClosedChecking)

Creates a new DelegatingStatement.

Parameters:

connection - the Connection that created this DelegatingStatement; must not be null

delegate - the Statement instance to which all operations will be delegated; must not be null

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

strictClosedChecking - if true, then this DelegatingStatement's isClosed() method will be invoked before every operation that cannot take place on a closed statement, and, if it returns true, the operation in question will fail with a SQLException

Throws:

NullPointerException - if either connection or delegate is null

See Also:

• getConnection()

Method Details

delegate

protected final S delegate()

Returns the Statement to which all operations will be delegated.

This method never returns null.

Returns:

the Statement to which all operations will be delegated; never null

isCloseable

public boolean isCloseable()
                    throws SQLException

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

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

Returns:

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

Throws:

SQLException - if isClosed() throws a SQLException

See Also:

• setCloseable(boolean)
• close()
• isClosed()

setCloseable

public void setCloseable(boolean closeable)

Sets the closeable status of this DelegatingStatement.

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

Parameters:

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

See Also:

• isCloseable()
• close()
• Statement.close()
• isClosed()

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Statement

Throws:

SQLException

close

public void close()
           throws SQLException

Overrides the Statement.close() method so that when it is invoked this DelegatingStatement 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 Statement

Throws:

SQLException - if an error occurs

See Also:

• isCloseable()

executeQuery

public ResultSet executeQuery(String sql)
                       throws SQLException

Specified by:

executeQuery in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

getMaxFieldSize

public int getMaxFieldSize()
                    throws SQLException

Specified by:

getMaxFieldSize in interface Statement

Throws:

SQLException

setMaxFieldSize

public void setMaxFieldSize(int max)
                     throws SQLException

Specified by:

setMaxFieldSize in interface Statement

Throws:

SQLException

getMaxRows

public int getMaxRows()
               throws SQLException

Specified by:

getMaxRows in interface Statement

Throws:

SQLException

setMaxRows

public void setMaxRows(int max)
                throws SQLException

Specified by:

setMaxRows in interface Statement

Throws:

SQLException

setEscapeProcessing

public void setEscapeProcessing(boolean enable)
                         throws SQLException

Specified by:

setEscapeProcessing in interface Statement

Throws:

SQLException

getQueryTimeout

public int getQueryTimeout()
                    throws SQLException

Specified by:

getQueryTimeout in interface Statement

Throws:

SQLException

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws SQLException

Specified by:

setQueryTimeout in interface Statement

Throws:

SQLException

cancel

public void cancel()
            throws SQLException

Specified by:

cancel in interface Statement

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Statement

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Statement

Throws:

SQLException

setCursorName

public void setCursorName(String name)
                   throws SQLException

Specified by:

setCursorName in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

getResultSet

public ResultSet getResultSet()
                       throws SQLException

Specified by:

getResultSet in interface Statement

Throws:

SQLException

getUpdateCount

public int getUpdateCount()
                   throws SQLException

Specified by:

getUpdateCount in interface Statement

Throws:

SQLException

getMoreResults

public boolean getMoreResults()
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

setFetchDirection

public void setFetchDirection(int direction)
                       throws SQLException

Specified by:

setFetchDirection in interface Statement

Throws:

SQLException

getFetchDirection

public int getFetchDirection()
                      throws SQLException

Specified by:

getFetchDirection in interface Statement

Throws:

SQLException

setFetchSize

public void setFetchSize(int rows)
                  throws SQLException

Specified by:

setFetchSize in interface Statement

Throws:

SQLException

getFetchSize

public int getFetchSize()
                 throws SQLException

Specified by:

getFetchSize in interface Statement

Throws:

SQLException

getResultSetConcurrency

public int getResultSetConcurrency()
                            throws SQLException

Specified by:

getResultSetConcurrency in interface Statement

Throws:

SQLException

getResultSetType

public int getResultSetType()
                     throws SQLException

Specified by:

getResultSetType in interface Statement

Throws:

SQLException

addBatch

public void addBatch(String sql)
              throws SQLException

Specified by:

addBatch in interface Statement

Throws:

SQLException

clearBatch

public void clearBatch()
                throws SQLException

Specified by:

clearBatch in interface Statement

Throws:

SQLException

executeBatch

public int[] executeBatch()
                   throws SQLException

Specified by:

executeBatch in interface Statement

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws SQLException

Returns the Connection supplied at construction time.

Specified by:

getConnection in interface Statement

Returns:

the Connection supplied at construction time; never null

Throws:

SQLException - not thrown by the default implementation of this method

See Also:

• DelegatingStatement(Connection, Statement, boolean, boolean)

getMoreResults

public boolean getMoreResults(int current)
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException

Specified by:

getGeneratedKeys in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql,
 int autoGeneratedKeys)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql,
 int[] columnIndexes)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql,
 String[] columnNames)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql,
 int autoGeneratedKeys)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql,
 int[] columnIndexes)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql,
 String[] columnNames)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

getResultSetHoldability

public int getResultSetHoldability()
                            throws SQLException

Specified by:

getResultSetHoldability in interface Statement

Throws:

SQLException

setPoolable

public void setPoolable(boolean poolable)
                 throws SQLException

Specified by:

setPoolable in interface Statement

Throws:

SQLException

isPoolable

public boolean isPoolable()
                   throws SQLException

Specified by:

isPoolable in interface Statement

Throws:

SQLException

closeOnCompletion

public void closeOnCompletion()
                       throws SQLException

Specified by:

closeOnCompletion in interface Statement

Throws:

SQLException

isCloseOnCompletion

public boolean isCloseOnCompletion()
                            throws SQLException

Specified by:

isCloseOnCompletion in interface Statement

Throws:

SQLException

getLargeUpdateCount

public long getLargeUpdateCount()
                         throws SQLException

Specified by:

getLargeUpdateCount in interface Statement

Throws:

SQLException

setLargeMaxRows

public void setLargeMaxRows(long max)
                     throws SQLException

Specified by:

setLargeMaxRows in interface Statement

Throws:

SQLException

getLargeMaxRows

public long getLargeMaxRows()
                     throws SQLException

Specified by:

getLargeMaxRows in interface Statement

Throws:

SQLException

executeLargeBatch

public long[] executeLargeBatch()
                         throws SQLException

Specified by:

executeLargeBatch in interface Statement

Throws:

SQLException

executeLargeUpdate

public long executeLargeUpdate(String sql)
                        throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

executeLargeUpdate

public long executeLargeUpdate(String sql,
 int autoGeneratedKeys)
                        throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

executeLargeUpdate

public long executeLargeUpdate(String sql,
 int[] columnIndexes)
                        throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

executeLargeUpdate

public long executeLargeUpdate(String sql,
 String[] columnNames)
                        throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

enquoteLiteral

public String enquoteLiteral(String val)
                      throws SQLException

Specified by:

enquoteLiteral in interface Statement

Throws:

SQLException

enquoteIdentifier

public String enquoteIdentifier(String identifier,
 boolean alwaysQuote)
                         throws SQLException

Specified by:

enquoteIdentifier in interface Statement

Throws:

SQLException

isSimpleIdentifier

public boolean isSimpleIdentifier(String identifier)
                           throws SQLException

Specified by:

isSimpleIdentifier in interface Statement

Throws:

SQLException

enquoteNCharLiteral

public String enquoteNCharLiteral(String val)
                           throws SQLException

Specified by:

enquoteNCharLiteral in interface Statement

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

checkOpen

protected final void checkOpen()
                        throws SQLException

Ensures this DelegatingStatement is not closed, if strict closed checking was enabled at construction time.

If a subclass overrides the isClosed() method, the override must not call this method or undefined behavior, such as an infinite loop, may result.

This method is intended for advanced use cases only and almost all users of this class will have no reason to call it.

Throws:

SQLException - if this DelegatingStatement was created with strict closed checking enabled and an invocation of the isClosed() method returns true, or if some other database access error occurs