Class EntityManagerFactoryBuilder.Builder

java.lang.Object

org.springframework.boot.jpa.EntityManagerFactoryBuilder.Builder

Enclosing class:

EntityManagerFactoryBuilder

public final class EntityManagerFactoryBuilder.Builder
extends Object

A fluent builder for a LocalContainerEntityManagerFactoryBean.

Since:

4.0.0

Author:

Dave Syer, Phillip Webb, Stephane Nicoll

Method Summary

Modifier and Type	Method	Description
LocalContainerEntityManagerFactoryBean	build()	Build a new LocalContainerEntityManagerFactoryBean instance from this builder.
EntityManagerFactoryBuilder.Builder	jta(boolean jta)	Configure if using a JTA DataSource, i.e.
EntityManagerFactoryBuilder.Builder	managedTypes(@Nullable PersistenceManagedTypes managedTypes)	The persistence managed types, providing both the managed entities and packages the entity manager should consider.
EntityManagerFactoryBuilder.Builder	mappingResources(String @Nullable ... mappingResources)	The mapping resources (equivalent to <mapping-file> entries in persistence.xml) for the persistence unit.
EntityManagerFactoryBuilder.Builder	packages(Class<?>... basePackageClasses)	The classes whose packages should be scanned for @Entity annotations.
EntityManagerFactoryBuilder.Builder	packages(String @Nullable ... packagesToScan)	The names of packages to scan for @Entity annotations.
EntityManagerFactoryBuilder.Builder	persistenceUnit(@Nullable String persistenceUnit)	The name of the persistence unit.
EntityManagerFactoryBuilder.Builder	properties(Map<String,?> properties)	Generic properties for standard JPA or vendor-specific configuration.

Methods inherited from class Object

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

Method Details

managedTypes

public EntityManagerFactoryBuilder.Builder managedTypes(@Nullable PersistenceManagedTypes managedTypes)

The persistence managed types, providing both the managed entities and packages the entity manager should consider.

Parameters:

managedTypes - managed types.

Returns:

the builder for fluent usage

packages

public EntityManagerFactoryBuilder.Builder packages(String @Nullable ... packagesToScan)

The names of packages to scan for @Entity annotations.

Parameters:

packagesToScan - packages to scan

Returns:

the builder for fluent usage

See Also:

• managedTypes(PersistenceManagedTypes)

packages

public EntityManagerFactoryBuilder.Builder packages(Class<?>... basePackageClasses)

The classes whose packages should be scanned for @Entity annotations.

Parameters:

basePackageClasses - the classes to use

Returns:

the builder for fluent usage

See Also:

• managedTypes(PersistenceManagedTypes)

persistenceUnit

public EntityManagerFactoryBuilder.Builder persistenceUnit(@Nullable String persistenceUnit)

The name of the persistence unit. If only building one EntityManagerFactory you can omit this, but if there are more than one in the same application you should give them distinct names.

Parameters:

persistenceUnit - the name of the persistence unit

Returns:

the builder for fluent usage

properties

public EntityManagerFactoryBuilder.Builder properties(Map<String,?> properties)

Generic properties for standard JPA or vendor-specific configuration. These properties override any values provided in the constructor.

Parameters:

properties - the properties to use

Returns:

the builder for fluent usage

mappingResources

public EntityManagerFactoryBuilder.Builder mappingResources(String @Nullable ... mappingResources)

The mapping resources (equivalent to <mapping-file> entries in persistence.xml) for the persistence unit.

Note that mapping resources must be relative to the classpath root, e.g. "META-INF/mappings.xml" or "com/mycompany/repository/mappings.xml", so that they can be loaded through ClassLoader.getResource().

Parameters:

mappingResources - the mapping resources to use

Returns:

the builder for fluent usage

jta

public EntityManagerFactoryBuilder.Builder jta(boolean jta)

Configure if using a JTA DataSource, i.e. if setDataSource or setJtaDataSource should be called on the LocalContainerEntityManagerFactoryBean.

Parameters:

jta - if the data source is JTA

Returns:

the builder for fluent usage

build

public LocalContainerEntityManagerFactoryBean build()

Build a new LocalContainerEntityManagerFactoryBean instance from this builder.

Returns:

the built LocalContainerEntityManagerFactoryBean