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

java.lang.Object
io.helidon.data.sql.common.SqlConfig.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>
Direct Known Subclasses:
JdbcClientConfig.BuilderBase, JpaPersistenceUnitConfig.BuilderBase, SqlConfig.Builder
Enclosing interface:
SqlConfig
public abstract static class SqlConfig.BuilderBase<BUILDER extends SqlConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends SqlConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Fluent API builder base for SqlConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(SqlConfig 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(SqlConfig.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

    • dataSource

      public BUILDER dataSource(String dataSourceName)
      Uses a registered data source as the connection source.

      This compatibility overload is equivalent to dataSourceName(dataSourceName).

      Parameters:
      dataSourceName - registered data source name
      Returns:
      updated builder instance
      Throws:
      NullPointerException - if the data source name is null

    • 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 SqlConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends SqlConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearConnection

      public BUILDER clearConnection()
      Clear existing value of connection.
      Returns:
      updated builder instance
      See Also:

    • connection

      public BUILDER connection(ConnectionConfig connection)
      Direct JDBC connection properties.
      Parameters:
      connection - configured connection properties
      Returns:
      updated builder instance
      See Also:

    • connection

      public BUILDER connection(Consumer<ConnectionConfig.Builder> consumer)
      Direct JDBC connection properties.
      Parameters:
      consumer - consumer of builder of configured connection properties
      Returns:
      updated builder instance
      See Also:

    • connection

      public BUILDER connection(Supplier<? extends ConnectionConfig> supplier)
      Direct JDBC connection properties.
      Parameters:
      supplier - supplier of configured connection properties
      Returns:
      updated builder instance
      See Also:

    • clearDataSourceName

      public BUILDER clearDataSourceName()
      Clear existing value of dataSourceName.
      Returns:
      updated builder instance
      See Also:

    • dataSourceName

      public BUILDER dataSourceName(String dataSourceName)
      Name of the registered DataSource to use.
      Parameters:
      dataSourceName - configured data source name
      Returns:
      updated builder instance
      See Also:

    • clearDataSource

      public BUILDER clearDataSource()
      Clear existing value of dataSource.
      Returns:
      updated builder instance
      See Also:

    • dataSource

      public BUILDER dataSource(DataSource dataSource)
      Existing DataSource owned by the application.

      This option is available only through programmatic builders. The application retains ownership of the data source lifecycle.

      Parameters:
      dataSource - configured data source
      Returns:
      updated builder instance
      See Also:

    • connection

      public Optional<ConnectionConfig> connection()
      Direct JDBC connection properties.
      Returns:
      configured connection properties

    • dataSourceName

      public Optional<String> dataSourceName()
      Name of the registered DataSource to use.
      Returns:
      configured data source name

    • dataSource

      public Optional<DataSource> dataSource()
      Existing DataSource owned by the application.

      This option is available only through programmatic builders. The application retains ownership of the data source lifecycle.

      Returns:
      configured data source

    • 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