Class SqlConfig.Builder

java.lang.Object

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

io.helidon.data.sql.common.SqlConfig.Builder

All Implemented Interfaces:

Prototype.Builder<SqlConfig.Builder, SqlConfig>, Builder<SqlConfig.Builder, SqlConfig>, ConfigBuilderSupport.ConfiguredBuilder<SqlConfig.Builder, SqlConfig>, Supplier<SqlConfig>

Enclosing interface:

SqlConfig

public static class SqlConfig.Builder
extends SqlConfig.BuilderBase<SqlConfig.Builder, SqlConfig>
implements Builder<SqlConfig.Builder, SqlConfig>

Fluent API builder for SqlConfig.

Nested Class Summary

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
SqlConfig	build()	Create an instance from this builder.
SqlConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class SqlConfig.BuilderBase

clearConnection, clearDataSource, clearDataSourceName, config, config, connection, connection, connection, connection, dataSource, dataSource, dataSource, dataSourceName, dataSourceName, from, from, preBuildPrototype, toString, validatePrototype

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

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 SqlConfig	get()
default SqlConfig.Builder	identity()	Instance of this builder as the correct type.
default SqlConfig.Builder	update(Consumer<SqlConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public SqlConfig 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<SqlConfig.Builder, SqlConfig>

Returns:

an instance of the setup object created from this builder

build

public SqlConfig 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<SqlConfig.Builder, SqlConfig>

Returns:

instance of the built type