Class JpaPersistenceUnitConfig.Builder

java.lang.Object

io.helidon.data.sql.common.SqlConfig.BuilderBase<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>

io.helidon.data.jakarta.persistence.JpaPersistenceUnitConfig.BuilderBase<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>

io.helidon.data.jakarta.persistence.JpaPersistenceUnitConfig.Builder

All Implemented Interfaces:

Prototype.Builder<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>, Builder<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>, ConfigBuilderSupport.ConfiguredBuilder<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>, Supplier<JpaPersistenceUnitConfig>

Enclosing interface:

JpaPersistenceUnitConfig

public static class JpaPersistenceUnitConfig.Builder
extends JpaPersistenceUnitConfig.BuilderBase<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>
implements Builder<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>

Fluent API builder for JpaPersistenceUnitConfig.

Nested Class Summary

Nested classes/interfaces inherited from class JpaPersistenceUnitConfig.BuilderBase

JpaPersistenceUnitConfig.BuilderBase.JpaPersistenceUnitConfigImpl

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.

Method Summary

Modifier and Type	Method	Description
JpaPersistenceUnitConfig	build()	Create an instance from this builder.
JpaPersistenceUnitConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class JpaPersistenceUnitConfig.BuilderBase

addManagedClass, addManagedClasses, addProperties, clearDropScript, clearInitScript, clearManagedClasses, clearProviderClassName, config, dropScript, dropScript, from, from, initScript, initScript, managedClasses, managedClasses, name, name, preBuildPrototype, properties, properties, providerClassName, providerClassName, putProperty, toString, validatePrototype

Modifier and Type	Method	Description
JpaPersistenceUnitConfig.Builder	addManagedClass(Class managedClass)	Managed persistence entities.
JpaPersistenceUnitConfig.Builder	addManagedClasses(Set<? extends Class> managedClasses)	Managed persistence entities.
JpaPersistenceUnitConfig.Builder	addProperties(Map<String,String> properties)	Additional persistence unit or connection properties.
JpaPersistenceUnitConfig.Builder	clearDropScript()	Clear existing value of dropScript.
JpaPersistenceUnitConfig.Builder	clearInitScript()	Clear existing value of initScript.
JpaPersistenceUnitConfig.Builder	clearManagedClasses()	Clear all managedClasses.
JpaPersistenceUnitConfig.Builder	clearProviderClassName()	Clear existing value of providerClassName.
JpaPersistenceUnitConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Optional<Path>	dropScript()	Path to database cleanup script on classpath.
JpaPersistenceUnitConfig.Builder	dropScript(Path dropScript)	Path to database cleanup script on classpath.
JpaPersistenceUnitConfig.Builder	from(JpaPersistenceUnitConfig prototype)	Update this builder from an existing prototype instance.
JpaPersistenceUnitConfig.Builder	from(JpaPersistenceUnitConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Path>	initScript()	Path to database initialization script on classpath.
JpaPersistenceUnitConfig.Builder	initScript(Path initScript)	Path to database initialization script on classpath.
Set<Class>	managedClasses()	Managed persistence entities.
JpaPersistenceUnitConfig.Builder	managedClasses(Set<? extends Class> managedClasses)	Managed persistence entities.
String	name()	Name of this persistence unit.
JpaPersistenceUnitConfig.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.
JpaPersistenceUnitConfig.Builder	properties(Map<String,String> properties)	Additional persistence unit or connection properties.
Optional<String>	providerClassName()	Persistence provider class name.
JpaPersistenceUnitConfig.Builder	providerClassName(String providerClassName)	Persistence provider class name.
JpaPersistenceUnitConfig.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
JpaPersistenceUnitConfig.Builder	clearConnection()	Clear existing value of connection.
JpaPersistenceUnitConfig.Builder	clearDataSource()	Clear existing value of dataSource.
JpaPersistenceUnitConfig.Builder	clearDataSourceName()	Clear existing value of dataSourceName.
protected Optional<Config>	config()	Configuration used to configure this instance.
Optional<ConnectionConfig>	connection()	Direct JDBC connection properties.
JpaPersistenceUnitConfig.Builder	connection(ConnectionConfig connection)	Direct JDBC connection properties.
JpaPersistenceUnitConfig.Builder	connection(Consumer<ConnectionConfig.Builder> consumer)	Direct JDBC connection properties.
JpaPersistenceUnitConfig.Builder	connection(Supplier<? extends ConnectionConfig> supplier)	Direct JDBC connection properties.
Optional<DataSource>	dataSource()	Existing DataSource owned by the application.
JpaPersistenceUnitConfig.Builder	dataSource(String dataSourceName)	Uses a registered data source as the connection source.
JpaPersistenceUnitConfig.Builder	dataSource(DataSource dataSource)	Existing DataSource owned by the application.
Optional<String>	dataSourceName()	Name of the registered DataSource to use.
JpaPersistenceUnitConfig.Builder	dataSourceName(String dataSourceName)	Name of the registered DataSource to use.
JpaPersistenceUnitConfig.Builder	from(SqlConfig prototype)	Update this builder from an existing prototype instance.
JpaPersistenceUnitConfig.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 Builder

get, identity, update

Modifier and Type	Method	Description
default JpaPersistenceUnitConfig	get()
default JpaPersistenceUnitConfig.Builder	identity()	Instance of this builder as the correct type.
default JpaPersistenceUnitConfig.Builder	update(Consumer<JpaPersistenceUnitConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default JpaPersistenceUnitConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public JpaPersistenceUnitConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>

Returns:

an instance of the setup object created from this builder

build

public JpaPersistenceUnitConfig build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<JpaPersistenceUnitConfig.Builder, JpaPersistenceUnitConfig>

Returns:

instance of the built type