StatementContext (jdbi3 Core 3.9.0 API)

java.lang.Object
- org.jdbi.v3.core.statement.StatementContext

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class StatementContext
extends Object
implements Closeable
```
The statement context provides access to statement-local configuration. Context is inherited from the parent Handle initially and changes will not outlive the statement. The context will be passed through most major jdbi APIs. DISCLAIMER: The class is not intended to be extended. The final modifier is absent to allow mock tools to create a mock object of this class in the user code.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCleanable(Cleanable cleanable)` Registers a `Cleanable` to be invoked when the statement context is closed.
`void`	`close()`
`void`	`define(String key, Object value)` Define an attribute for in this context.
`Optional<Argument>`	`findArgumentFor(QualifiedType<?> type, Object value)` Obtain an argument for given value in this context
`Optional<Argument>`	`findArgumentFor(Type type, Object value)` Obtain an argument for given value in this context
`Optional<Collector<?,?,?>>`	`findCollectorFor(Type containerType)` Obtain a collector for the given type.
`<T> Optional<ColumnMapper<T>>`	`findColumnMapperFor(Class<T> type)` Obtain a column mapper for the given type in this context.
`<T> Optional<ColumnMapper<T>>`	`findColumnMapperFor(GenericType<T> type)` Obtain a column mapper for the given type in this context.
`<T> Optional<ColumnMapper<T>>`	`findColumnMapperFor(QualifiedType<T> type)` Obtain a column mapper for the given qualified type in this context.
`Optional<ColumnMapper<?>>`	`findColumnMapperFor(Type type)` Obtain a column mapper for the given type in this context.
`Optional<Type>`	`findElementTypeFor(Type containerType)` Returns the element type for the given container type.
`<T> Optional<RowMapper<T>>`	`findMapperFor(Class<T> type)` Obtain a mapper for the given type in this context.
`<T> Optional<RowMapper<T>>`	`findMapperFor(GenericType<T> type)` Obtain a mapper for the given type in this context.
`<T> Optional<RowMapper<T>>`	`findMapperFor(QualifiedType<T> type)` Obtain a mapper for the given qualified type in this context.
`Optional<RowMapper<?>>`	`findMapperFor(Type type)` Obtain a mapper for the given type in this context.
`<T> Optional<RowMapper<T>>`	`findRowMapperFor(Class<T> type)` Obtain a row mapper for the given type in this context.
`<T> Optional<RowMapper<T>>`	`findRowMapperFor(GenericType<T> type)` Obtain a row mapper for the given type in this context.
`Optional<RowMapper<?>>`	`findRowMapperFor(Type type)` Obtain a row mapper for the given type in this context.
`Optional<SqlArrayType<?>>`	`findSqlArrayTypeFor(Type elementType)` Obtain an `SqlArrayType` for the given array element type in this context
`Object`	`getAttribute(String key)` Obtain the value of an attribute
`Map<String,Object>`	`getAttributes()` Returns the attributes applied in this context.
`Binding`	`getBinding()`
`Instant`	`getCompletionMoment()`
`ConfigRegistry`	`getConfig()`
`<C extends JdbiConfig<C>> C`	`getConfig(Class<C> configClass)` Gets the configuration object of the given type, associated with this context.
`Connection`	`getConnection()` Obtain the JDBC connection being used for this statement
`long`	`getElapsedTime(ChronoUnit unit)` Convenience method to measure elapsed time between start of query execution and completion or exception as appropriate.
`Instant`	`getExceptionMoment()`
`Instant`	`getExecutionMoment()`
`ExtensionMethod`	`getExtensionMethod()`
`String[]`	`getGeneratedKeysColumnNames()`
`ParsedSql`	`getParsedSql()` Obtain the parsed SQL statement
`String`	`getRawSql()` Obtain the initial sql for the statement used to create the statement
`String`	`getRenderedSql()` Obtain the rendered SQL statement
`SqlArrayArgumentStrategy`	`getSqlArrayArgumentStrategy()`
`PreparedStatement`	`getStatement()` Obtain the actual prepared statement being used.
`boolean`	`isConcurrentUpdatable()` Return if the statement should be concurrent updatable.
`boolean`	`isReturningGeneratedKeys()`
`void`	`setCompletionMoment(Instant completionMoment)` for jdbi-internal use only
`void`	`setConcurrentUpdatable(boolean concurrentUpdatable)` Set the context to create a concurrent updatable result set.
`void`	`setExceptionMoment(Instant exceptionMoment)` for jdbi-internal use only
`void`	`setExecutionMoment(Instant executionMoment)` for jdbi-internal use only
`void`	`setGeneratedKeysColumnNames(String[] generatedKeysColumnNames)` Set the generated key column names.
`void`	`setReturningGeneratedKeys(boolean b)` Sets whether the current statement returns generated keys.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addCleanable
```
public void addCleanable(Cleanable cleanable)
```
    Registers a Cleanable to be invoked when the statement context is closed. Cleanables can be registered on a statement context, which will be cleaned up when the statement finishes or (in the case of a ResultIterator), the object representing the results is closed.
    Resources cleaned up by Jdbi include ResultSet, Statement, Handle, Array, and StatementBuilder.
    
    Parameters:
    
    cleanable - the Cleanable to clean on close
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - define
```
public void define(String key,
                   Object value)
```
    Define an attribute for in this context.
    
    Parameters:
    
    key - the key for the attribute
    
    value - the value for the attribute
  - findArgumentFor
```
@Beta
public Optional<Argument> findArgumentFor(QualifiedType<?> type,
                                                Object value)
```
    Obtain an argument for given value in this context
    
    Parameters:
    
    type - the type of the argument.
    
    value - the argument value.
    
    Returns:
    
    an Argument for the given value.
  - findArgumentFor
```
public Optional<Argument> findArgumentFor(Type type,
                                          Object value)
```
    Obtain an argument for given value in this context
    
    Parameters:
    
    type - the type of the argument.
    
    value - the argument value.
    
    Returns:
    
    an Argument for the given value.
  - findCollectorFor
```
public Optional<Collector<?,?,?>> findCollectorFor(Type containerType)
```
    Obtain a collector for the given type.
    
    Parameters:
    
    containerType - the container type.
    
    Returns:
    
    a Collector for the given container type, or empty null if no collector is registered for the given type.
  - findColumnMapperFor
```
public <T> Optional<ColumnMapper<T>> findColumnMapperFor(Class<T> type)
```
    Obtain a column mapper for the given type in this context.
    
    Type Parameters:
    
    T - the type to map
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a ColumnMapper for the given type, or empty if no column mapper is registered for the given type.
  - findColumnMapperFor
```
public <T> Optional<ColumnMapper<T>> findColumnMapperFor(GenericType<T> type)
```
    Obtain a column mapper for the given type in this context.
    
    Type Parameters:
    
    T - the type to map
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a ColumnMapper for the given type, or empty if no column mapper is registered for the given type.
  - findColumnMapperFor
```
@Beta
public <T> Optional<ColumnMapper<T>> findColumnMapperFor(QualifiedType<T> type)
```
    Obtain a column mapper for the given qualified type in this context.
    
    Parameters:
    
    type - the qualified target type to map to
    
    Returns:
    
    a ColumnMapper for the given type, or empty if no column mapper is registered for the given type.
  - findColumnMapperFor
```
public Optional<ColumnMapper<?>> findColumnMapperFor(Type type)
```
    Obtain a column mapper for the given type in this context.
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a ColumnMapper for the given type, or empty if no column mapper is registered for the given type.
  - findElementTypeFor
```
public Optional<Type> findElementTypeFor(Type containerType)
```
    Returns the element type for the given container type.
    
    Parameters:
    
    containerType - the container type.
    
    Returns:
    
    the element type for the given container type, if available.
  - findMapperFor
```
public <T> Optional<RowMapper<T>> findMapperFor(Class<T> type)
```
    Obtain a mapper for the given type in this context.
    
    Type Parameters:
    
    T - the type to map
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a mapper for the given type, or empty if no row or column mappers is registered for the given type.
  - findMapperFor
```
public <T> Optional<RowMapper<T>> findMapperFor(GenericType<T> type)
```
    Obtain a mapper for the given type in this context.
    
    Type Parameters:
    
    T - the type to map
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a mapper for the given type, or empty if no row or column mappers is registered for the given type.
  - findMapperFor
```
@Beta
public <T> Optional<RowMapper<T>> findMapperFor(QualifiedType<T> type)
```
    Obtain a mapper for the given qualified type in this context.
    
    Parameters:
    
    type - the target qualified type to map to
    
    Returns:
    
    a mapper for the given qualified type, or empty if no row or column mappers is registered for the given type.
  - findMapperFor
```
public Optional<RowMapper<?>> findMapperFor(Type type)
```
    Obtain a mapper for the given type in this context.
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a mapper for the given type, or empty if no row or column mappers is registered for the given type.
  - findRowMapperFor
```
public <T> Optional<RowMapper<T>> findRowMapperFor(Class<T> type)
```
    Obtain a row mapper for the given type in this context.
    
    Type Parameters:
    
    T - the type to map
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a RowMapper for the given type, or empty if no row mapper is registered for the given type.
  - findRowMapperFor
```
public <T> Optional<RowMapper<T>> findRowMapperFor(GenericType<T> type)
```
    Obtain a row mapper for the given type in this context.
    
    Type Parameters:
    
    T - the type to map
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a RowMapper for the given type, or empty if no row mapper is registered for the given type.
  - findRowMapperFor
```
public Optional<RowMapper<?>> findRowMapperFor(Type type)
```
    Obtain a row mapper for the given type in this context.
    
    Parameters:
    
    type - the target type to map to
    
    Returns:
    
    a RowMapper for the given type, or empty if no row mapper is registered for the given type.
  - findSqlArrayTypeFor
```
public Optional<SqlArrayType<?>> findSqlArrayTypeFor(Type elementType)
```
    Obtain an SqlArrayType for the given array element type in this context
    
    Parameters:
    
    elementType - the array element type.
    
    Returns:
    
    an SqlArrayType for the given element type.
  - getAttribute
```
public Object getAttribute(String key)
```
    Obtain the value of an attribute
    
    Parameters:
    
    key - the name of the attribute
    
    Returns:
    
    the value of the attribute
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Returns the attributes applied in this context.
    
    Returns:
    
    the defined attributes.
  - getBinding
```
public Binding getBinding()
```
    Returns:
    
    the statement binding
  - getCompletionMoment
```
@Nullable
public Instant getCompletionMoment()
```
    Returns:
    
    the Instant at which query execution ended, if it did so successfully
  - getConfig
```
public ConfigRegistry getConfig()
```
    Returns:
    
    the ConfigRegistry this context owns
  - getConfig
```
public <C extends JdbiConfig<C>> C getConfig(Class<C> configClass)
```
    Gets the configuration object of the given type, associated with this context.
    
    Type Parameters:
    
    C - the configuration type
    
    Parameters:
    
    configClass - the configuration type
    
    Returns:
    
    the configuration object of the given type, associated with this context.
  - getConnection
```
public Connection getConnection()
```
    Obtain the JDBC connection being used for this statement
    
    Returns:
    
    the JDBC connection
  - getElapsedTime
```
public long getElapsedTime(ChronoUnit unit)
```
    Convenience method to measure elapsed time between start of query execution and completion or exception as appropriate. Do not call with a null argument or before a query has executed/exploded.
    
    Parameters:
    
    unit - the time unit to convert to
    
    Returns:
    
    the elapsed time in the given unit
  - getExceptionMoment
```
@Nullable
public Instant getExceptionMoment()
```
    Returns:
    
    the Instant at which query execution ended, if it did so with an exception
  - getExecutionMoment
```
@Nullable
public Instant getExecutionMoment()
```
    Returns:
    
    the Instant at which query execution began
  - getExtensionMethod
```
public ExtensionMethod getExtensionMethod()
```
  - getGeneratedKeysColumnNames
```
public String[] getGeneratedKeysColumnNames()
```
    Returns:
    
    the generated key column names, if any
  - getParsedSql
```
public ParsedSql getParsedSql()
```
    Obtain the parsed SQL statement
    Not available until until statement execution time
    
    Returns:
    
    the sql statement as it will be executed against the database
  - getRawSql
```
public String getRawSql()
```
    Obtain the initial sql for the statement used to create the statement
    
    Returns:
    
    the initial sql
  - getRenderedSql
```
public String getRenderedSql()
```
    Obtain the rendered SQL statement
    Not available until until statement execution time
    
    Returns:
    
    the sql statement after processing template directives.
  - getSqlArrayArgumentStrategy
```
public SqlArrayArgumentStrategy getSqlArrayArgumentStrategy()
```
    Returns:
    
    the strategy used to bind array-type arguments to SQL statements
  - getStatement
```
public PreparedStatement getStatement()
```
    Obtain the actual prepared statement being used.
    Not available until execution time
    
    Returns:
    
    Obtain the actual prepared statement being used.
  - isConcurrentUpdatable
```
public boolean isConcurrentUpdatable()
```
    Return if the statement should be concurrent updatable. If this returns true, the concurrency level of the created ResultSet will be ResultSet.CONCUR_UPDATABLE, otherwise the result set is not updatable, and will have concurrency level ResultSet.CONCUR_READ_ONLY.
    
    Returns:
    
    if the statement generated should be concurrent updatable.
  - isReturningGeneratedKeys
```
public boolean isReturningGeneratedKeys()
```
    Returns:
    
    whether the statement being generated is expected to return generated keys.
  - setCompletionMoment
```
public void setCompletionMoment(Instant completionMoment)
```
    for jdbi-internal use only
  - setConcurrentUpdatable
```
public void setConcurrentUpdatable(boolean concurrentUpdatable)
```
    Set the context to create a concurrent updatable result set. This cannot be combined with isReturningGeneratedKeys(), only one option may be selected. It does not make sense to combine these either, as one applies to queries, and the other applies to updates.
    
    Parameters:
    
    concurrentUpdatable - if the result set should be concurrent updatable.
  - setExceptionMoment
```
public void setExceptionMoment(Instant exceptionMoment)
```
    for jdbi-internal use only
  - setExecutionMoment
```
public void setExecutionMoment(Instant executionMoment)
```
    for jdbi-internal use only
  - setGeneratedKeysColumnNames
```
public void setGeneratedKeysColumnNames(String[] generatedKeysColumnNames)
```
    Set the generated key column names.
    
    Parameters:
    
    generatedKeysColumnNames - the generated key column names
  - setReturningGeneratedKeys
```
public void setReturningGeneratedKeys(boolean b)
```
    Sets whether the current statement returns generated keys.
    
    Parameters:
    
    b - return generated keys?

Class StatementContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addCleanable

close

define

findArgumentFor

findArgumentFor

findCollectorFor

findColumnMapperFor

findColumnMapperFor

findColumnMapperFor

findColumnMapperFor

findElementTypeFor

findMapperFor

findMapperFor

findMapperFor

findMapperFor

findRowMapperFor

findRowMapperFor

findRowMapperFor

findSqlArrayTypeFor

getAttribute

getAttributes

getBinding

getCompletionMoment

getConfig

getConfig

getConnection

getElapsedTime

getExceptionMoment

getExecutionMoment

getExtensionMethod

getGeneratedKeysColumnNames

getParsedSql

getRawSql

getRenderedSql

getSqlArrayArgumentStrategy

getStatement

isConcurrentUpdatable

isReturningGeneratedKeys

setCompletionMoment

setConcurrentUpdatable

setExceptionMoment

setExecutionMoment

setGeneratedKeysColumnNames

setReturningGeneratedKeys