Class JpaPersistenceUnitConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JpaPersistenceUnitConfig>
java.lang.Object
io.helidon.data.sql.common.SqlConfig.BuilderBase<BUILDER,PROTOTYPE>
io.helidon.data.jakarta.persistence.JpaPersistenceUnitConfig.BuilderBase<BUILDER,PROTOTYPE>
- Type Parameters:
BUILDER
- type of the builder extending this abstract builderPROTOTYPE
- type of the prototype interface that would be built byPrototype.Builder.buildPrototype()
- All Implemented Interfaces:
Prototype.Builder<BUILDER,
,PROTOTYPE> ConfigBuilderSupport.ConfiguredBuilder<BUILDER,
,PROTOTYPE> ConfigBuilderSupport.ConfiguredBuilder<BUILDER,
PROTOTYPE>
- Direct Known Subclasses:
JpaPersistenceUnitConfig.Builder
- Enclosing interface:
JpaPersistenceUnitConfig
public abstract static class JpaPersistenceUnitConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JpaPersistenceUnitConfig>
extends SqlConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for
JpaPersistenceUnitConfig
.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
Generated implementation of the prototype, can be extended by descendant prototype implementations.Nested classes/interfaces inherited from class io.helidon.data.sql.common.SqlConfig.BuilderBase
SqlConfig.BuilderBase.SqlConfigImpl
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddManagedClass
(Class managedClass) Managed persistence entities.addManagedClasses
(Set<? extends Class> managedClasses) Managed persistence entities.addProperties
(Map<String, String> properties) Additional persistence unit or connection properties.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.config()
If this instance was configured, this would be the config instance used.Deprecated.Update builder from configuration (node of this type).Path to database cleanup script on classpath.dropScript
(Path dropScript) Path to database cleanup script on classpath.from
(JpaPersistenceUnitConfig prototype) Update this builder from an existing prototype instance.from
(JpaPersistenceUnitConfig.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.Path to database initialization script on classpath.initScript
(Path initScript) Path to database initialization script on classpath.Managed persistence entities.managedClasses
(Set<? extends Class> managedClasses) Managed persistence entities.name()
Name of this persistence unit.Name of this persistence unit.protected void
Handles providers and decorators.Additional persistence unit or connection properties.properties
(Map<String, String> properties) Additional persistence unit or connection properties.Persistence provider class name.providerClassName
(String providerClassName) Persistence provider class name.putProperty
(String key, String property) Additional persistence unit or connection properties.toString()
protected void
Validates required properties.Methods inherited from class io.helidon.data.sql.common.SqlConfig.BuilderBase
clearConnection, clearDataSource, connection, connection, connection, dataSource, dataSource, from, from
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
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
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.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 interfaceConfigBuilderSupport.ConfiguredBuilder<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig> - Overrides:
config
in classSqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig> - Parameters:
config
- configuration instance used to obtain values to update this builder- Returns:
- updated builder instance
-
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 interfaceConfigBuilderSupport.ConfiguredBuilder<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig> - Overrides:
config
in classSqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig> - Parameters:
config
- configuration instance used to obtain values to update this builder- Returns:
- updated builder instance
-
name
Name of this persistence unit.- Parameters:
name
- the persistence unit name- Returns:
- updated builder instance
- See Also:
-
clearProviderClassName
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
providerClassName
Persistence provider class name. Implementation ofjakarta.persistence.spi.PersistenceProvider
, e.g.org.eclipse.persistence.jpa.PersistenceProvider
Allows proper persistence provider selection when multiple providers are available.- Parameters:
providerClassName
- fully qualified name of the persistence provider class- Returns:
- updated builder instance
- See Also:
-
clearInitScript
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
initScript
Path to database initialization script on classpath.- Parameters:
initScript
- database initialization script path- Returns:
- updated builder instance
- See Also:
-
clearDropScript
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
dropScript
Path to database cleanup script on classpath.- Parameters:
dropScript
- database cleanup script path- Returns:
- updated builder instance
- See Also:
-
properties
Additional persistence unit or connection properties. This method replaces all values with the new ones.- Parameters:
properties
- the properties- Returns:
- updated builder instance
- See Also:
-
addProperties
Additional persistence unit or connection properties. This method keeps existing values, then puts all new values into the map.- Parameters:
properties
- the properties- Returns:
- updated builder instance
- See Also:
-
putProperty
Additional persistence unit or connection properties. This method adds a new value to the map, or replaces it if the key already exists.- Parameters:
key
- key to add or replaceproperty
- new value for the key- Returns:
- updated builder instance
- See Also:
-
managedClasses
Managed persistence entities.- Parameters:
managedClasses
- the entities list- Returns:
- updated builder instance
- See Also:
-
addManagedClasses
Managed persistence entities.- Parameters:
managedClasses
- the entities list- Returns:
- updated builder instance
- See Also:
-
addManagedClass
Managed persistence entities.- Parameters:
managedClass
- the entities list- Returns:
- updated builder instance
- See Also:
-
name
Name of this persistence unit.- Returns:
- the name
-
providerClassName
Persistence provider class name. Implementation ofjakarta.persistence.spi.PersistenceProvider
, e.g.org.eclipse.persistence.jpa.PersistenceProvider
Allows proper persistence provider selection when multiple providers are available.- Returns:
- the provider class name
-
initScript
Path to database initialization script on classpath.- Returns:
- the init script
-
dropScript
Path to database cleanup script on classpath.- Returns:
- the drop script
-
properties
Additional persistence unit or connection properties.- Returns:
- the properties
-
managedClasses
Managed persistence entities.- Returns:
- the managed classes
-
config
If this instance was configured, this would be the config instance used.- Overrides:
config
in classSqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig> - Returns:
- config node used to configure this builder, or empty if not configured
-
toString
- Overrides:
toString
in classSqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>
-
preBuildPrototype
protected void preBuildPrototype()Handles providers and decorators.- Overrides:
preBuildPrototype
in classSqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>
-
validatePrototype
protected void validatePrototype()Validates required properties.- Overrides:
validatePrototype
in classSqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>
-
config(io.helidon.config.Config)