Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

make javadoc consistent 

yes, these methods actually do still accept detached objects
as of today, but that's already deprecated and we're going to
turn it off in the future

Signed-off-by: Gavin King <gavin@hibernate.org>
This commit is contained in:
Gavin King 2024-04-17 18:42:27 +02:00
parent 8fdf86e8a5
commit 810e5fc76d
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
hibernate-core/src/main/java/org/hibernate/Session.java
View File

@ -799,7 +799,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* This operation cascades to associated instances if the association is * This operation cascades to associated instances if the association is
* mapped with {@link org.hibernate.annotations.CascadeType#LOCK}. * mapped with {@link org.hibernate.annotations.CascadeType#LOCK}.
* *
* @param object a persistent or transient instance * @param object a persistent instance
* @param lockMode the lock level * @param lockMode the lock level
*/ */
void lock(Object object, LockMode lockMode); void lock(Object object, LockMode lockMode);
@ -811,7 +811,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* This operation cascades to associated instances if the association is * This operation cascades to associated instances if the association is
* mapped with {@link org.hibernate.annotations.CascadeType#LOCK}. * mapped with {@link org.hibernate.annotations.CascadeType#LOCK}.
* *
* @param object a persistent or transient instance * @param object a persistent instance
* @param lockOptions the lock options * @param lockOptions the lock options
* *
* @since 6.2 * @since 6.2
@ -830,7 +830,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* mapped with {@link org.hibernate.annotations.CascadeType#LOCK}. * mapped with {@link org.hibernate.annotations.CascadeType#LOCK}.
* *
* @param entityName the name of the entity * @param entityName the name of the entity
* @param object a persistent or transient instance * @param object a persistent instance associated with this session
* @param lockMode the lock level * @param lockMode the lock level
* *
* @deprecated use {@link #lock(Object, LockMode)} * @deprecated use {@link #lock(Object, LockMode)}
@ -881,7 +881,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* This operation requests {@link LockMode#READ}. To obtain a stronger lock, * This operation requests {@link LockMode#READ}. To obtain a stronger lock,
* call {@link #refresh(Object, LockMode)}. * call {@link #refresh(Object, LockMode)}.
* *
* @param object a persistent or detached instance * @param object a persistent instance associated with this session
*/ */
void refresh(Object object); void refresh(Object object);
@ -901,7 +901,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* with {@link jakarta.persistence.CascadeType#REFRESH}. * with {@link jakarta.persistence.CascadeType#REFRESH}.
* *
* @param entityName the name of the entity * @param entityName the name of the entity
* @param object a persistent or detached instance * @param object a persistent instance associated with this session
* *
* @deprecated use {@link #refresh(Object)} * @deprecated use {@link #refresh(Object)}
*/ */
@ -914,7 +914,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* <p> * <p>
* Convenient form of {@link #refresh(Object, LockOptions)} * Convenient form of {@link #refresh(Object, LockOptions)}
* *
* @param object a persistent or detached instance * @param object a persistent instance associated with this session
* @param lockMode the lock mode to use * @param lockMode the lock mode to use
* *
* @see #refresh(Object, LockOptions) * @see #refresh(Object, LockOptions)
@ -925,7 +925,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* Reread the state of the given managed instance from the underlying database, * Reread the state of the given managed instance from the underlying database,
* obtaining the given {@link LockMode}. * obtaining the given {@link LockMode}.
* *
* @param object a persistent or detached instance * @param object a persistent instance associated with this session
* @param lockOptions contains the lock mode to use * @param lockOptions contains the lock mode to use
*/ */
void refresh(Object object, LockOptions lockOptions); void refresh(Object object, LockOptions lockOptions);
@ -935,7 +935,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* obtaining the given {@link LockMode}. * obtaining the given {@link LockMode}.
* *
* @param entityName the name of the entity * @param entityName the name of the entity
* @param object a persistent or detached instance * @param object a persistent instance associated with this session
* @param lockOptions contains the lock mode to use * @param lockOptions contains the lock mode to use
* *
* @deprecated use {@link #refresh(Object, LockOptions)} * @deprecated use {@link #refresh(Object, LockOptions)}
@ -957,7 +957,7 @@ public interface Session extends SharedSessionContract, EntityManager {
* Determine the current {@link LockMode} of the given managed instance associated * Determine the current {@link LockMode} of the given managed instance associated
* with this session. * with this session.
* *
* @param object a persistent instance * @param object a persistent instance associated with this session
* *
* @return the current lock mode * @return the current lock mode
*/ */