diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java b/hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java index a56139839a..276205cf1c 100644 --- a/hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java +++ b/hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java @@ -158,8 +158,10 @@ public @interface NamedNativeQuery { /** * The {@linkplain org.hibernate.query.SynchronizeableQuery query spaces} * involved in this query. + *

+ * Typically, the names of tables which are referenced by the query. * - * @see org.hibernate.query.SynchronizeableQuery + * @see org.hibernate.query.SynchronizeableQuery#addSynchronizedQuerySpace * @see org.hibernate.jpa.HibernateHints#HINT_NATIVE_SPACES * @see Synchronize */ diff --git a/hibernate-core/src/main/java/org/hibernate/jpa/HibernateHints.java b/hibernate-core/src/main/java/org/hibernate/jpa/HibernateHints.java index c951c11978..6ec0e027ce 100644 --- a/hibernate-core/src/main/java/org/hibernate/jpa/HibernateHints.java +++ b/hibernate-core/src/main/java/org/hibernate/jpa/HibernateHints.java @@ -126,7 +126,7 @@ public interface HibernateHints { /** * Hint for specifying the - * {@link org.hibernate.query.SynchronizeableQuery query spaces} + * {@linkplain org.hibernate.query.SynchronizeableQuery query spaces} * that affect the results of a native query. *

* Passed value can be any of: @@ -135,8 +135,11 @@ public interface HibernateHints { *

  • an array of the spaces, or *
  • a string with a whitespace-separated list of the spaces. * + *

    + * Typically, these are the names of tables which are referenced by + * the query. * - * @see org.hibernate.query.SynchronizeableQuery + * @see org.hibernate.query.SynchronizeableQuery#addSynchronizedQuerySpace * @see #HINT_FLUSH_MODE * @see org.hibernate.annotations.NamedNativeQuery#querySpaces */ diff --git a/hibernate-core/src/main/java/org/hibernate/query/SynchronizeableQuery.java b/hibernate-core/src/main/java/org/hibernate/query/SynchronizeableQuery.java index 474c508acd..4acbd75a81 100644 --- a/hibernate-core/src/main/java/org/hibernate/query/SynchronizeableQuery.java +++ b/hibernate-core/src/main/java/org/hibernate/query/SynchronizeableQuery.java @@ -50,26 +50,35 @@ import org.hibernate.MappingException; */ public interface SynchronizeableQuery { /** - * Obtain the list of query spaces the query is synchronized on. + * Obtain the list of query spaces this query is synchronized with. * * @return The list of query spaces upon which the query is synchronized. */ Collection getSynchronizedQuerySpaces(); /** - * Adds a query space. + * Add a query space. The effect of this call is to: + *

    * - * @param querySpace The query space to be auto-flushed for this query. + * @param querySpace The name of the query space, usually the name of a database table. * * @return {@code this}, for method chaining */ SynchronizeableQuery addSynchronizedQuerySpace(String querySpace); /** - * Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking. Same as - * {@link #addSynchronizedQuerySpace} for all tables associated with the given entity. + * Add all query spaces associated with the entity with the given names. + *

    + * Same as {@link #addSynchronizedQuerySpace} for all tables mapped by the given entity. * - * @param entityName The name of the entity upon whose defined query spaces we should additionally synchronize. + * @param entityName The name of an entity. * * @return {@code this}, for method chaining * @@ -78,10 +87,11 @@ public interface SynchronizeableQuery { SynchronizeableQuery addSynchronizedEntityName(String entityName) throws MappingException; /** - * Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking. Same as - * {@link #addSynchronizedQuerySpace} for all tables associated with the given entity. + * Add all query spaces associated with the entity with the given type. + *

    + * Same as {@link #addSynchronizedQuerySpace} for all tables mapped by the given entity. * - * @param entityClass The class of the entity upon whose defined query spaces we should additionally synchronize. + * @param entityClass The class of the entity. * * @return {@code this}, for method chaining *