play.db.jpa

Interface JPAApi

All Known Implementing Classes:

DefaultJPAApi

public interface JPAApi

JPA API.

Method Summary

Modifier and Type	Method and Description
javax.persistence.EntityManager	em() Deprecated. The EntityManager is supplied as lambda parameter instead when using withTransaction(Function)
javax.persistence.EntityManager	em(java.lang.String name) Get a newly created EntityManager for the specified persistence unit name.
void	shutdown() Close all entity manager factories.
JPAApi	start() Initialise JPA entity manager factories.
void	withTransaction(java.util.function.Consumer<javax.persistence.EntityManager> block) Run a block of code with a newly created EntityManager for the default Persistence Unit.
<T> T	withTransaction(java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a newly created EntityManager for the default Persistence Unit.
void	withTransaction(java.lang.Runnable block) Deprecated. Use withTransaction(Consumer)
void	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Consumer<javax.persistence.EntityManager> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Supplier<T> block) Deprecated. Use withTransaction(String, boolean, Function)
void	withTransaction(java.lang.String name, java.util.function.Consumer<javax.persistence.EntityManager> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.lang.String name, java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.util.function.Supplier<T> block) Deprecated. Use withTransaction(Function)

Method Detail

start

JPAApi start()

Initialise JPA entity manager factories.

Returns:

JPAApi instance

em

javax.persistence.EntityManager em(java.lang.String name)

Get a newly created EntityManager for the specified persistence unit name.

Parameters:

name - The persistence unit name

Returns:

EntityManager for the specified persistence unit name

em

@Deprecated
javax.persistence.EntityManager em()

Deprecated. The EntityManager is supplied as lambda parameter instead when using withTransaction(Function)

Get the EntityManager for a particular persistence unit for this thread.

Returns:

EntityManager for the specified persistence unit name

withTransaction

<T> T withTransaction(java.util.function.Function<javax.persistence.EntityManager,T> block)

Run a block of code with a newly created EntityManager for the default Persistence Unit.

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransaction

void withTransaction(java.util.function.Consumer<javax.persistence.EntityManager> block)

Run a block of code with a newly created EntityManager for the default Persistence Unit.

Parameters:

block - Block of code to execute

withTransaction

<T> T withTransaction(java.lang.String name,
                      java.util.function.Function<javax.persistence.EntityManager,T> block)

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

block - Block of code to execute

Returns:

code execution result

withTransaction

void withTransaction(java.lang.String name,
                     java.util.function.Consumer<javax.persistence.EntityManager> block)

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Parameters:

name - The persistence unit name

block - Block of code to execute

withTransaction

<T> T withTransaction(java.lang.String name,
                      boolean readOnly,
                      java.util.function.Function<javax.persistence.EntityManager,T> block)

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute

Returns:

code execution result

withTransaction

void withTransaction(java.lang.String name,
                     boolean readOnly,
                     java.util.function.Consumer<javax.persistence.EntityManager> block)

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute

withTransaction

@Deprecated
<T> T withTransaction(java.util.function.Supplier<T> block)

Deprecated. Use withTransaction(Function)

Run a block of code in a JPA transaction.

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransaction

@Deprecated
void withTransaction(java.lang.Runnable block)

Deprecated. Use withTransaction(Consumer)

Run a block of code in a JPA transaction.

Parameters:

block - Block of code to execute

withTransaction

@Deprecated
<T> T withTransaction(java.lang.String name,
                                  boolean readOnly,
                                  java.util.function.Supplier<T> block)

Deprecated. Use withTransaction(String, boolean, Function)

Run a block of code in a JPA transaction.

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute

Returns:

code execution result

shutdown

void shutdown()

Close all entity manager factories.