javadoc improvements
This commit is contained in:
parent
7b3c77c0c3
commit
80feb108fb
|
@ -27,8 +27,9 @@ import static org.hibernate.annotations.FetchMode.JOIN;
|
||||||
* <p>
|
* <p>
|
||||||
* Additional fetch strategy overrides may be added to a named fetch
|
* Additional fetch strategy overrides may be added to a named fetch
|
||||||
* profile by annotating the fetched associations themselves with the
|
* profile by annotating the fetched associations themselves with the
|
||||||
* {@link FetchProfileOverride @Fetch} annotation, specifying the
|
* {@link FetchProfileOverride @FetchProfileOverride} annotation,
|
||||||
* {@linkplain FetchProfileOverride#profile name of the fetch profile}.
|
* specifying the {@linkplain FetchProfileOverride#profile name of the
|
||||||
|
* fetch profile}.
|
||||||
* <p>
|
* <p>
|
||||||
* A named fetch profile must be explicitly enabled in a given session
|
* A named fetch profile must be explicitly enabled in a given session
|
||||||
* by calling {@link org.hibernate.Session#enableFetchProfile(String)}
|
* by calling {@link org.hibernate.Session#enableFetchProfile(String)}
|
||||||
|
|
|
@ -33,6 +33,8 @@ import static org.hibernate.annotations.FetchMode.JOIN;
|
||||||
*
|
*
|
||||||
* @author Gavin King
|
* @author Gavin King
|
||||||
*
|
*
|
||||||
|
* @since 6.3
|
||||||
|
*
|
||||||
* @see FetchMode
|
* @see FetchMode
|
||||||
* @see FetchProfile
|
* @see FetchProfile
|
||||||
* @see FetchProfile.FetchOverride
|
* @see FetchProfile.FetchOverride
|
||||||
|
|
|
@ -7,6 +7,8 @@
|
||||||
package org.hibernate.annotations;
|
package org.hibernate.annotations;
|
||||||
|
|
||||||
|
|
||||||
|
import org.hibernate.Incubating;
|
||||||
|
|
||||||
import java.lang.annotation.Retention;
|
import java.lang.annotation.Retention;
|
||||||
import java.lang.annotation.Target;
|
import java.lang.annotation.Target;
|
||||||
|
|
||||||
|
@ -62,6 +64,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
||||||
*
|
*
|
||||||
* @author Gavin King
|
* @author Gavin King
|
||||||
*/
|
*/
|
||||||
|
@Incubating
|
||||||
@Target(TYPE)
|
@Target(TYPE)
|
||||||
@Retention(RUNTIME)
|
@Retention(RUNTIME)
|
||||||
public @interface View {
|
public @interface View {
|
||||||
|
|
|
@ -1045,6 +1045,8 @@ public interface AvailableSettings {
|
||||||
* By default, Hibernate only uses subselect fetching for collections
|
* By default, Hibernate only uses subselect fetching for collections
|
||||||
* explicitly annotated {@code @Fetch(SUBSELECT)}.
|
* explicitly annotated {@code @Fetch(SUBSELECT)}.
|
||||||
*
|
*
|
||||||
|
* @since 6.3
|
||||||
|
*
|
||||||
* @see org.hibernate.annotations.FetchMode#SUBSELECT
|
* @see org.hibernate.annotations.FetchMode#SUBSELECT
|
||||||
* @see org.hibernate.Session#setSubselectFetchingEnabled(boolean)
|
* @see org.hibernate.Session#setSubselectFetchingEnabled(boolean)
|
||||||
* @see org.hibernate.boot.SessionFactoryBuilder#applySubselectFetchEnabled(boolean)
|
* @see org.hibernate.boot.SessionFactoryBuilder#applySubselectFetchEnabled(boolean)
|
||||||
|
|
|
@ -67,6 +67,20 @@ import org.hibernate.graph.GraphSemantic;
|
||||||
* {@link #setParameter(int, Object)} allow arguments to be bound to named
|
* {@link #setParameter(int, Object)} allow arguments to be bound to named
|
||||||
* and ordinal parameters defined by the query.
|
* and ordinal parameters defined by the query.
|
||||||
* </ul>
|
* </ul>
|
||||||
|
* <p>
|
||||||
|
* A query may have explicit <em>fetch joins</em>, specified using the syntax
|
||||||
|
* {@code join fetch} in HQL, or via {@link jakarta.persistence.criteria.From#fetch}
|
||||||
|
* in the criteria API. Additional fetch joins may be added by:
|
||||||
|
* <ul>
|
||||||
|
* <li>setting an {@link EntityGraph} by calling
|
||||||
|
* {@link #setEntityGraph(EntityGraph, GraphSemantic)}, or
|
||||||
|
* <li>enabling a fetch profile, using {@link Session#enableFetchProfile(String)}.
|
||||||
|
* </ul>
|
||||||
|
* The special built-in fetch profile named
|
||||||
|
* {@value org.hibernate.mapping.FetchProfile#HIBERNATE_DEFAULT_PROFILE} adds
|
||||||
|
* a fetch join for every {@link jakarta.persistence.FetchType#EAGER eager}
|
||||||
|
* {@code @ManyToOne} or {@code @OneToOne} association belonging to an entity
|
||||||
|
* returned by the query.
|
||||||
*
|
*
|
||||||
* @author Steve Ebersole
|
* @author Steve Ebersole
|
||||||
*/
|
*/
|
||||||
|
@ -193,6 +207,8 @@ public interface SelectionQuery<R> extends CommonQueryContract {
|
||||||
* <p>
|
* <p>
|
||||||
* This is an alternative way to specify the associations which
|
* This is an alternative way to specify the associations which
|
||||||
* should be fetched as part of the initial query.
|
* should be fetched as part of the initial query.
|
||||||
|
*
|
||||||
|
* @since 6.3
|
||||||
*/
|
*/
|
||||||
SelectionQuery<R> setEntityGraph(EntityGraph<R> graph, GraphSemantic semantic);
|
SelectionQuery<R> setEntityGraph(EntityGraph<R> graph, GraphSemantic semantic);
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue