Module io.helidon.dbclient.jdbc

Package io.helidon.dbclient.jdbc

Class JdbcParametersConfig.BuilderBase<BUILDER extends JdbcParametersConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcParametersConfig>

java.lang.Object

io.helidon.dbclient.jdbc.JdbcParametersConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

JdbcParametersConfig.Builder

Enclosing interface:

JdbcParametersConfig

public abstract static class JdbcParametersConfig.BuilderBase<BUILDER extends JdbcParametersConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcParametersConfig>
extends Object
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for JdbcParametersConfig.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
protected Optional<Config>	config()	Configuration used to configure this instance.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(JdbcParametersConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(JdbcParametersConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
boolean	setObjectForJavaTime()	Set all java.time Date/Time values directly using PreparedStatement.setObject(int, Object).
BUILDER	setObjectForJavaTime(boolean setObjectForJavaTime)	Set all java.time Date/Time values directly using PreparedStatement.setObject(int, Object).
int	stringBindingSize()	String values with length above this limit will be bound using PreparedStatement.setCharacterStream(int, java.io.Reader, int) if useStringBinding() is set to true.
BUILDER	stringBindingSize(int stringBindingSize)	String values with length above this limit will be bound using PreparedStatement.setCharacterStream(int, java.io.Reader, int) if useStringBinding() is set to true.
boolean	timestampForLocalTime()	Use PreparedStatement.setTimestamp(int, java.sql.Timestamp) to set LocalTime values when true or use PreparedStatement.setTime(int, java.sql.Time) when false.
BUILDER	timestampForLocalTime(boolean timestampForLocalTime)	Use PreparedStatement.setTimestamp(int, java.sql.Timestamp) to set LocalTime values when true or use PreparedStatement.setTime(int, java.sql.Time) when false.
String	toString()
boolean	useByteArrayBinding()	Use PreparedStatement.setBinaryStream(int, java.io.InputStream, int) binding for byte[] values.
BUILDER	useByteArrayBinding(boolean useByteArrayBinding)	Use PreparedStatement.setBinaryStream(int, java.io.InputStream, int) binding for byte[] values.
boolean	useNString()	Use SQL NCHAR, NVARCHAR or LONGNVARCHAR value conversion for String values.
BUILDER	useNString(boolean useNString)	Use SQL NCHAR, NVARCHAR or LONGNVARCHAR value conversion for String values.
boolean	useStringBinding()	Use PreparedStatement.setCharacterStream(int, java.io.Reader, int) binding for String values with length above stringBindingSize() limit.
BUILDER	useStringBinding(boolean useStringBinding)	Use PreparedStatement.setCharacterStream(int, java.io.Reader, int) binding for String values with length above stringBindingSize() limit.
protected void	validatePrototype()	Validates required properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(JdbcParametersConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(JdbcParametersConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends JdbcParametersConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcParametersConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends JdbcParametersConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcParametersConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

useNString

public BUILDER useNString(boolean useNString)

Use SQL NCHAR, NVARCHAR or LONGNVARCHAR value conversion for String values. Default value is false.

Parameters:

useNString - whether NString conversion is used

Returns:

updated builder instance

See Also:

• useNString()

useStringBinding

public BUILDER useStringBinding(boolean useStringBinding)

Use PreparedStatement.setCharacterStream(int, java.io.Reader, int) binding for String values with length above stringBindingSize() limit. Default value is true.

Parameters:

useStringBinding - whether to use CharArrayReader binding

Returns:

updated builder instance

See Also:

• useStringBinding()

stringBindingSize

public BUILDER stringBindingSize(int stringBindingSize)

String values with length above this limit will be bound using PreparedStatement.setCharacterStream(int, java.io.Reader, int) if useStringBinding() is set to true. Default value is 1024.

Parameters:

stringBindingSize - String values length limit for CharArrayReader binding

Returns:

updated builder instance

See Also:

• stringBindingSize()

useByteArrayBinding

public BUILDER useByteArrayBinding(boolean useByteArrayBinding)

Use PreparedStatement.setBinaryStream(int, java.io.InputStream, int) binding for byte[] values. Default value is true.

Parameters:

useByteArrayBinding - whether to use ByteArrayInputStream binding

Returns:

updated builder instance

See Also:

• useByteArrayBinding()

timestampForLocalTime

public BUILDER timestampForLocalTime(boolean timestampForLocalTime)

Use PreparedStatement.setTimestamp(int, java.sql.Timestamp) to set LocalTime values when true or use PreparedStatement.setTime(int, java.sql.Time) when false. Default value is true.

This option is vendor specific. Most of the databases are fine with Timestamp, but for example SQL Server requires Time. This option does not apply when setObjectForJavaTime() is set to true.

Parameters:

timestampForLocalTime - whether to use Timestamp instead of Time for LocalTime values

Returns:

updated builder instance

See Also:

• timestampForLocalTime()

setObjectForJavaTime

public BUILDER setObjectForJavaTime(boolean setObjectForJavaTime)

Set all java.time Date/Time values directly using PreparedStatement.setObject(int, Object). This option shall work fine for recent JDBC drivers. Default value is true.

Parameters:

setObjectForJavaTime - whether to use PreparedStatement.setObject(int, Object) for java.time Date/Time values

Returns:

updated builder instance

See Also:

• setObjectForJavaTime()

useNString

public boolean useNString()

Use SQL NCHAR, NVARCHAR or LONGNVARCHAR value conversion for String values. Default value is false.

Returns:

whether NString conversion is used

useStringBinding

public boolean useStringBinding()

Use PreparedStatement.setCharacterStream(int, java.io.Reader, int) binding for String values with length above stringBindingSize() limit. Default value is true.

Returns:

whether to use CharArrayReader binding

stringBindingSize

public int stringBindingSize()

String values with length above this limit will be bound using PreparedStatement.setCharacterStream(int, java.io.Reader, int) if useStringBinding() is set to true. Default value is 1024.

Returns:

String values length limit for CharArrayReader binding

useByteArrayBinding

public boolean useByteArrayBinding()

Use PreparedStatement.setBinaryStream(int, java.io.InputStream, int) binding for byte[] values. Default value is true.

Returns:

whether to use ByteArrayInputStream binding

timestampForLocalTime

public boolean timestampForLocalTime()

Use PreparedStatement.setTimestamp(int, java.sql.Timestamp) to set LocalTime values when true or use PreparedStatement.setTime(int, java.sql.Time) when false. Default value is true.

This option is vendor specific. Most of the databases are fine with Timestamp, but for example SQL Server requires Time. This option does not apply when setObjectForJavaTime() is set to true.

Returns:

whether to use Timestamp instead of Time for LocalTime values

setObjectForJavaTime

public boolean setObjectForJavaTime()

Set all java.time Date/Time values directly using PreparedStatement.setObject(int, Object). This option shall work fine for recent JDBC drivers. Default value is true.

Returns:

whether to use PreparedStatement.setObject(int, Object) for java.time Date/Time values

toString

public String toString()

Overrides:

toString in class Object

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

validatePrototype

protected void validatePrototype()

Validates required properties.

config

protected Optional<Config> config()

Configuration used to configure this instance.

Returns:

config instance