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 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:

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 Classes

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

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BUILDER	addManagedClass(Class managedClass)	Managed persistence entities.
BUILDER	addManagedClasses(Set<? extends Class> managedClasses)	Managed persistence entities.
BUILDER	addProperties(Map<String,String> properties)	Additional persistence unit or connection properties.
BUILDER	clearDropScript()	Clear existing value of dropScript.
BUILDER	clearInitScript()	Clear existing value of initScript.
BUILDER	clearManagedClasses()	Clear all managedClasses.
BUILDER	clearProviderClassName()	Clear existing value of providerClassName.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
Optional<Path>	dropScript()	Path to database cleanup script on classpath.
BUILDER	dropScript(Path dropScript)	Path to database cleanup script on classpath.
BUILDER	from(JpaPersistenceUnitConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(JpaPersistenceUnitConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Path>	initScript()	Path to database initialization script on classpath.
BUILDER	initScript(Path initScript)	Path to database initialization script on classpath.
Set<Class>	managedClasses()	Managed persistence entities.
BUILDER	managedClasses(Set<? extends Class> managedClasses)	Managed persistence entities.
String	name()	Name of this persistence unit.
BUILDER	name(String name)	Name of this persistence unit.
protected void	preBuildPrototype()	Handles providers and decorators.
Map<String,String>	properties()	Additional persistence unit or connection properties.
BUILDER	properties(Map<String,String> properties)	Additional persistence unit or connection properties.
Optional<String>	providerClassName()	Persistence provider class name.
BUILDER	providerClassName(String providerClassName)	Persistence provider class name.
BUILDER	putProperty(String key, String property)	Additional persistence unit or connection properties.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class SqlConfig.BuilderBase

clearConnection, clearDataSource, clearDataSourceName, config, connection, connection, connection, connection, dataSource, dataSource, dataSource, dataSourceName, dataSourceName, from, from

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

Methods inherited from class Object

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

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

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

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 JpaPersistenceUnitConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>

Overrides:

config in class SqlConfig.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

public BUILDER name(String name)

Name of this persistence unit.

Parameters:

name - the persistence unit name

Returns:

updated builder instance

See Also:

• name()

clearProviderClassName

public BUILDER clearProviderClassName()

Clear existing value of providerClassName.

Returns:

updated builder instance

See Also:

• providerClassName()

providerClassName

public BUILDER providerClassName(String providerClassName)

Persistence provider class name. Implementation of jakarta.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:

• providerClassName()

clearInitScript

public BUILDER clearInitScript()

Clear existing value of initScript.

Returns:

updated builder instance

See Also:

• initScript()

initScript

public BUILDER initScript(Path initScript)

Path to database initialization script on classpath.

Parameters:

initScript - database initialization script path

Returns:

updated builder instance

See Also:

• initScript()

clearDropScript

public BUILDER clearDropScript()

Clear existing value of dropScript.

Returns:

updated builder instance

See Also:

• dropScript()

dropScript

public BUILDER dropScript(Path dropScript)

Path to database cleanup script on classpath.

Parameters:

dropScript - database cleanup script path

Returns:

updated builder instance

See Also:

• dropScript()

properties

public BUILDER properties(Map<String,String> 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:

• properties()

addProperties

public BUILDER addProperties(Map<String,String> properties)

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:

• properties()

putProperty

public BUILDER putProperty(String key,
 String property)

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 replace

property - new value for the key

Returns:

updated builder instance

See Also:

• properties()

clearManagedClasses

public BUILDER clearManagedClasses()

Clear all managedClasses.

Returns:

updated builder instance

See Also:

• managedClasses()

managedClasses

public BUILDER managedClasses(Set<? extends Class> managedClasses)

Managed persistence entities.

Parameters:

managedClasses - the entities list

Returns:

updated builder instance

See Also:

• managedClasses()

addManagedClasses

public BUILDER addManagedClasses(Set<? extends Class> managedClasses)

Managed persistence entities.

Parameters:

managedClasses - the entities list

Returns:

updated builder instance

See Also:

• managedClasses()

addManagedClass

public BUILDER addManagedClass(Class managedClass)

Managed persistence entities.

Parameters:

managedClass - add single the entities list

Returns:

updated builder instance

See Also:

• managedClasses()

name

public String name()

Name of this persistence unit.

Returns:

the persistence unit name

providerClassName

public Optional<String> providerClassName()

Persistence provider class name. Implementation of jakarta.persistence.spi.PersistenceProvider, e.g. org.eclipse.persistence.jpa.PersistenceProvider Allows proper persistence provider selection when multiple providers are available.

Returns:

fully qualified name of the persistence provider class

initScript

public Optional<Path> initScript()

Path to database initialization script on classpath.

Returns:

database initialization script path

dropScript

public Optional<Path> dropScript()

Path to database cleanup script on classpath.

Returns:

database cleanup script path

properties

public Map<String,String> properties()

Additional persistence unit or connection properties.

Returns:

the properties

managedClasses

public Set<Class> managedClasses()

Managed persistence entities.

Returns:

the entities list

toString

public String toString()

Overrides:

toString in class SqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class SqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class SqlConfig.BuilderBase<BUILDER extends JpaPersistenceUnitConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JpaPersistenceUnitConfig>