Module io.helidon.data.sql.common
Package io.helidon.data.sql.common

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>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
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

    • 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 SqlConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SqlConfig>
      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 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 this property.
      Returns:
      updated builder instance
      See Also:

    • connection

      public BUILDER connection(ConnectionConfig connection)
      Configuration of a connection to a database. Alternative is to use dataSource().
      Parameters:
      connection - connection configuration
      Returns:
      updated builder instance
      See Also:

    • connection

      public BUILDER connection(Consumer<ConnectionConfig.Builder> consumer)
      Configuration of a connection to a database. Alternative is to use dataSource().
      Parameters:
      consumer - connection configuration
      Returns:
      updated builder instance
      See Also:

    • clearDataSource

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

    • dataSource

      public BUILDER dataSource(String dataSource)
      Name of the DataSource.
      Parameters:
      dataSource - the name to use for DataSource lookup
      Returns:
      updated builder instance
      See Also:

    • connection

      public Optional<ConnectionConfig> connection()
      Configuration of a connection to a database. Alternative is to use dataSource().
      Returns:
      the connection

    • dataSource

      public Optional<String> dataSource()
      Name of the DataSource.
      Returns:
      the data source

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.