Class JdbcClientConfig.Builder

java.lang.Object

io.helidon.data.sql.common.SqlConfig.BuilderBase<JdbcClientConfig.Builder, JdbcClientConfig>

io.helidon.data.jdbc.JdbcClientConfig.BuilderBase<JdbcClientConfig.Builder, JdbcClientConfig>

io.helidon.data.jdbc.JdbcClientConfig.Builder

All Implemented Interfaces:

Prototype.Builder<JdbcClientConfig.Builder, JdbcClientConfig>, Builder<JdbcClientConfig.Builder, JdbcClient>, ConfigBuilderSupport.ConfiguredBuilder<JdbcClientConfig.Builder, JdbcClientConfig>, Supplier<JdbcClient>

Enclosing interface:

JdbcClientConfig

public static class JdbcClientConfig.Builder
extends JdbcClientConfig.BuilderBase<JdbcClientConfig.Builder, JdbcClientConfig>
implements Builder<JdbcClientConfig.Builder, JdbcClient>

Fluent API builder for JdbcClient.

Nested Class Summary

Nested classes/interfaces inherited from class JdbcClientConfig.BuilderBase

JdbcClientConfig.BuilderBase.JdbcClientConfigImpl

Modifier and Type	Class	Description
protected static class	JdbcClientConfig.BuilderBase.JdbcClientConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class SqlConfig.BuilderBase

SqlConfig.BuilderBase.SqlConfigImpl

Modifier and Type	Class	Description
protected static class	SqlConfig.BuilderBase.SqlConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
JdbcClient	build()	Create an instance from this builder.
JdbcClientConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class JdbcClientConfig.BuilderBase

config, from, from, name, name, parameterCountCacheCapacity, parameterCountCacheCapacity, parameterCountCacheMaxSqlLength, parameterCountCacheMaxSqlLength, preBuildPrototype, toString, validatePrototype

Modifier and Type	Method	Description
JdbcClientConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
JdbcClientConfig.Builder	from(JdbcClientConfig prototype)	Update this builder from an existing prototype instance.
JdbcClientConfig.Builder	from(JdbcClientConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	name()	Logical name of this client.
JdbcClientConfig.Builder	name(String name)	Logical name of this client.
int	parameterCountCacheCapacity()	The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues.
JdbcClientConfig.Builder	parameterCountCacheCapacity(int parameterCountCacheCapacity)	The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues.
int	parameterCountCacheMaxSqlLength()	The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained.
JdbcClientConfig.Builder	parameterCountCacheMaxSqlLength(int parameterCountCacheMaxSqlLength)	The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class SqlConfig.BuilderBase

clearConnection, clearDataSource, clearDataSourceName, config, connection, connection, connection, connection, dataSource, dataSource, dataSource, dataSourceName, dataSourceName, from, from

Modifier and Type	Method	Description
JdbcClientConfig.Builder	clearConnection()	Clear existing value of connection.
JdbcClientConfig.Builder	clearDataSource()	Clear existing value of dataSource.
JdbcClientConfig.Builder	clearDataSourceName()	Clear existing value of dataSourceName.
protected Optional<Config>	config()	Configuration used to configure this instance.
Optional<ConnectionConfig>	connection()	Direct JDBC connection properties.
JdbcClientConfig.Builder	connection(ConnectionConfig connection)	Direct JDBC connection properties.
JdbcClientConfig.Builder	connection(Consumer<ConnectionConfig.Builder> consumer)	Direct JDBC connection properties.
JdbcClientConfig.Builder	connection(Supplier<? extends ConnectionConfig> supplier)	Direct JDBC connection properties.
Optional<DataSource>	dataSource()	Existing DataSource owned by the application.
JdbcClientConfig.Builder	dataSource(String dataSourceName)	Uses a registered data source as the connection source.
JdbcClientConfig.Builder	dataSource(DataSource dataSource)	Existing DataSource owned by the application.
Optional<String>	dataSourceName()	Name of the registered DataSource to use.
JdbcClientConfig.Builder	dataSourceName(String dataSourceName)	Name of the registered DataSource to use.
JdbcClientConfig.Builder	from(SqlConfig prototype)	Update this builder from an existing prototype instance.
JdbcClientConfig.Builder	from(SqlConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default JdbcClient	get()
default JdbcClientConfig.Builder	identity()	Instance of this builder as the correct type.
default JdbcClientConfig.Builder	update(Consumer<JdbcClientConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default JdbcClientConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public JdbcClientConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<JdbcClientConfig.Builder, JdbcClientConfig>

Returns:

an instance of the setup object created from this builder

build

public JdbcClient build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<JdbcClientConfig.Builder, JdbcClient>

Returns:

instance of the built type