Configurable (jdbi Core 3.0.0-beta2 API)

Type Parameters:

This - The subtype that implements this interface.

All Known Subinterfaces:

HandleSupplier

All Known Implementing Classes:

Batch, Call, Handle, Jdbi, PreparedBatch, Query, SqlStatement, Update
```
public interface Configurable<This>
```
A type with access to access and modify arbitrary Jdbi configuration.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <C extends JdbiConfig<C>> This`	`configure(Class<C> configClass, Consumer<C> configurer)` Passes the configuration object of the given type to the configurer, then returns this object.
`default This`	`define(String key, Object value)` Convenience method for `getConfig(SqlStatements.class).define(key, value)`
`ConfigRegistry`	`getConfig()` Returns the configuration registry associated with this object.
`default <C extends JdbiConfig<C>> C`	`getConfig(Class<C> configClass)` Gets the configuration object of the given type, associated with this object.
`default This`	`registerArgument(ArgumentFactory factory)` Convenience method for `getConfig(Arguments.class).register(factory)`
`default This`	`registerArrayType(Class<?> elementType, String sqlTypeName)` Convenience method for `getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)`
`default This`	`registerArrayType(SqlArrayType<?> arrayType)` Convenience method for `getConfig(SqlArrayTypes.class).register(arrayType)`
`default This`	`registerArrayType(SqlArrayTypeFactory factory)` Convenience method for `getConfig(SqlArrayTypes.class).register(factory)`
`default This`	`registerCollector(CollectorFactory factory)` Convenience method for `getConfig(JdbiCollectors.class).register(factory)`
`default This`	`registerColumnMapper(ColumnMapper<?> mapper)` Convenience method for `getConfig(ColumnMappers.class).register(mapper)`
`default This`	`registerColumnMapper(ColumnMapperFactory factory)` Convenience method for `getConfig(ColumnMappers.class).register(factory)`
`default This`	`registerColumnMapper(Type type, ColumnMapper<?> mapper)` Convenience method for `getConfig(ColumnMappers.class).register(type, mapper)`
`default This`	`registerExtension(ExtensionFactory factory)` Convenience method for `getConfig(Extensions.class).register(factory)`
`default This`	`registerRowMapper(RowMapper<?> mapper)` Convenience method for `getConfig(RowMappers.class).register(mapper)`
`default This`	`registerRowMapper(RowMapperFactory factory)` Convenience method for `getConfig(RowMappers.class).register(factory)`
`default This`	`registerRowMapper(Type type, RowMapper<?> mapper)` Convenience method for `getConfig(RowMappers.class).register(type, mapper)`
`default This`	`setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)` Convenience method for `getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)`
`default This`	`setSqlParser(SqlParser parser)` Convenience method for `getConfig(SqlStatements.class).setSqlParser(rewriter)`
`default This`	`setTemplateEngine(TemplateEngine templateEngine)` Convenience method for `getConfig(SqlStatements.class).setTemplateEngine(rewriter)`
`default This`	`setTimingCollector(TimingCollector collector)` Convenience method for `getConfig(SqlStatements.class).setTimingCollector(collector)`

- Method Detail
  - configure
```
default <C extends JdbiConfig<C>> This configure(Class<C> configClass,
                                                 Consumer<C> configurer)
```
    Passes the configuration object of the given type to the configurer, then returns this object.
    
    Type Parameters:
    
    C - the configuration type
    
    Parameters:
    
    configClass - the configuration type
    
    configurer - consumer that will be passed the configuration object
    
    Returns:
    
    this object (for call chaining)
  - define
```
default This define(String key,
                    Object value)
```
    Convenience method for getConfig(SqlStatements.class).define(key, value)
    
    Parameters:
    
    key - attribute name
    
    value - attribute value
    
    Returns:
    
    this
  - getConfig
```
ConfigRegistry getConfig()
```
    Returns the configuration registry associated with this object.
    
    Returns:
    
    the configuration registry associated with this object.
  - getConfig
```
default <C extends JdbiConfig<C>> C getConfig(Class<C> configClass)
```
    Gets the configuration object of the given type, associated with this object.
    
    Type Parameters:
    
    C - the configuration type
    
    Parameters:
    
    configClass - the configuration type
    
    Returns:
    
    the configuration object of the given type, associated with this object.
  - registerArgument
```
default This registerArgument(ArgumentFactory factory)
```
    Convenience method for getConfig(Arguments.class).register(factory)
    
    Parameters:
    
    factory - argument factory
    
    Returns:
    
    this
  - registerArrayType
```
default This registerArrayType(Class<?> elementType,
                               String sqlTypeName)
```
    Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)
    
    Parameters:
    
    elementType - element type
    
    sqlTypeName - SQL type name
    
    Returns:
    
    this
  - registerArrayType
```
default This registerArrayType(SqlArrayType<?> arrayType)
```
    Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)
    
    Parameters:
    
    arrayType - SQL array type
    
    Returns:
    
    this
  - registerArrayType
```
default This registerArrayType(SqlArrayTypeFactory factory)
```
    Convenience method for getConfig(SqlArrayTypes.class).register(factory)
    
    Parameters:
    
    factory - SQL array type factory
    
    Returns:
    
    this
  - registerCollector
```
default This registerCollector(CollectorFactory factory)
```
    Convenience method for getConfig(JdbiCollectors.class).register(factory)
    
    Parameters:
    
    factory - collector factory
    
    Returns:
    
    this
  - registerColumnMapper
```
default This registerColumnMapper(ColumnMapper<?> mapper)
```
    Convenience method for getConfig(ColumnMappers.class).register(mapper)
    
    Parameters:
    
    mapper - column mapper
    
    Returns:
    
    this
  - registerColumnMapper
```
default This registerColumnMapper(ColumnMapperFactory factory)
```
    Convenience method for getConfig(ColumnMappers.class).register(factory)
    
    Parameters:
    
    factory - column mapper factory
    
    Returns:
    
    this
  - registerColumnMapper
```
default This registerColumnMapper(Type type,
                                  ColumnMapper<?> mapper)
```
    Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
    
    Parameters:
    
    type - the type to register
    
    mapper - the mapper to use on that type
    
    Returns:
    
    this
  - registerExtension
```
default This registerExtension(ExtensionFactory factory)
```
    Convenience method for getConfig(Extensions.class).register(factory)
    
    Parameters:
    
    factory - extension factory
    
    Returns:
    
    this
  - registerRowMapper
```
default This registerRowMapper(RowMapper<?> mapper)
```
    Convenience method for getConfig(RowMappers.class).register(mapper)
    
    Parameters:
    
    mapper - row mapper
    
    Returns:
    
    this
  - registerRowMapper
```
default This registerRowMapper(RowMapperFactory factory)
```
    Convenience method for getConfig(RowMappers.class).register(factory)
    
    Parameters:
    
    factory - row mapper factory
    
    Returns:
    
    this
  - registerRowMapper
```
default This registerRowMapper(Type type,
                               RowMapper<?> mapper)
```
    Convenience method for getConfig(RowMappers.class).register(type, mapper)
    
    Parameters:
    
    type - to match
    
    mapper - row mapper
    
    Returns:
    
    this
  - setSqlArrayArgumentStrategy
```
default This setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)
```
    Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)
    
    Parameters:
    
    strategy - argument strategy
    
    Returns:
    
    this
  - setSqlParser
```
default This setSqlParser(SqlParser parser)
```
    Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)
    
    Parameters:
    
    parser - SQL parser
    
    Returns:
    
    this
  - setTemplateEngine
```
default This setTemplateEngine(TemplateEngine templateEngine)
```
    Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)
    
    Parameters:
    
    templateEngine - the template engine
    
    Returns:
    
    this
  - setTimingCollector
```
default This setTimingCollector(TimingCollector collector)
```
    Convenience method for getConfig(SqlStatements.class).setTimingCollector(collector)
    
    Parameters:
    
    collector - timing collector
    
    Returns:
    
    this

Interface Configurable<This>

Method Summary

Method Detail

configure

define

getConfig

getConfig

registerArgument

registerArrayType

registerArrayType

registerArrayType

registerCollector

registerColumnMapper

registerColumnMapper

registerColumnMapper

registerExtension

registerRowMapper

registerRowMapper

registerRowMapper

setSqlArrayArgumentStrategy

setSqlParser

setTemplateEngine

setTimingCollector