Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add overload of refresh() accepting an EntityGraph #672

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions api/src/main/java/jakarta/persistence/EntityGraph.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,32 @@
* The methods to add subgraphs implicitly create the corresponding
* attribute nodes as well; such attribute nodes should not be
* redundantly specified.
* <p>
* When used to specify fetching, an entity graph has two possible
* interpretations:
* <ul>
* <li>As a <em>load graph</em>, where every node explicitly added
* to or explicitly removed from the graph overrides the
* {@linkplain FetchType fetching strategy} of the attribute
* which was specified via annotations or XML descriptor, but
* the graph does not affect the fetching strategy of any
* attribute which was neither added to nor removed from the
* graph.
* <li>As a <em>fetch graph</em>, where the graph completely
* overrides every fetching strategy specified via annotations
* or XML descriptor, and every attribute not explicitly added
* to the graph is treated as {@link FetchType#LAZY}.
* </ul>
* <p>
* An entity graph passed as the first argument to
* {@link EntityManager#find(EntityGraph, Object, FindOption...)}
* is interpreted as a load graph.
* <p>
* When an entity graph is passed to
* {@link EntityManager#refresh(Object, EntityGraph)}, the graph
* completely overrides the effect of {@code cascade=REFRESH}, and
* each node belonging to the graph is treated as an instruction
* to refresh the corresponding attribute.
*
* @param <T> The type of the root entity.
*
Expand All @@ -36,6 +62,7 @@
* @see EntityManager#getEntityGraph(String)
* @see EntityManagerFactory#addNamedEntityGraph(String, EntityGraph)
* @see EntityManager#find(EntityGraph, Object, FindOption...)
* @see EntityManager#refresh(Object, EntityGraph)
*
* @since 2.1
*/
Expand Down
20 changes: 20 additions & 0 deletions api/src/main/java/jakarta/persistence/EntityManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -885,6 +885,26 @@ void refresh(Object entity, LockModeType lockMode,
void refresh(Object entity,
RefreshOption... options);

/**
* Refresh the state of the given managed entity instance from the
* database, along with all associated entities reachable by
* following the given {@link EntityGraph}, overwriting changes
* made to the entity, if any. This operation does not cascade to
* associations marked {@link CascadeType#REFRESH cascade=REFRESH}
* unless they are included in the given entity graph.
* @param entity a managed entity instance
* @throws IllegalArgumentException if the instance is not an entity
* or if the entity is not managed
* @throws TransactionRequiredException if there is no
* transaction when invoked on a container-managed
* entity manager of type
* {@link PersistenceContextType#TRANSACTION}
* @throws EntityNotFoundException if the entity no longer exists in
* the database
* @since 4.0
*/
<T> void refresh(T entity, EntityGraph<T> entityGraph);

/**
* Clear the persistence context, causing all managed entities to
* become detached. Changes made to entities that have not already
Expand Down
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/ch03-entity-operations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2071,7 +2071,7 @@ When the `jakarta.persistence.loadgraph`
property is used to specify an entity graph, attributes that are
specified by attribute nodes of the entity graph are treated as
`FetchType.EAGER` and attributes that are not specified are treated
according to their specified or default FetchType.
according to their specified or default `FetchType`.

The following rules apply. The rules of this
section are applied recursively.
Expand Down