Skip to content

Commit f2cec1c

Browse files
committed
minor javadoc improvements
1 parent 7e2f359 commit f2cec1c

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

hibernate-core/src/main/java/org/hibernate/query/SelectionQuery.java

+13-9
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ public interface SelectionQuery<R> extends CommonQueryContract {
147147
* {@code Object[]}.
148148
*
149149
* @return the results as a list
150+
*
151+
* @apiNote Synonym for {@link #list()}
150152
*/
151153
default List<R> getResultList() {
152154
return list();
@@ -179,9 +181,7 @@ default List<R> getResultList() {
179181
*
180182
* @return The results as a {@link Stream}
181183
*
182-
* @implNote The default implementation defined here simply returns
183-
* {@link #list()}{@code .stream()}. Concrete implementations
184-
* may be more efficient.
184+
* @apiNote Synonym for {@link #stream()}
185185
*/
186186
default Stream<R> getResultStream() {
187187
return stream();
@@ -198,6 +198,10 @@ default Stream<R> getResultStream() {
198198
*
199199
* @return The results as a {@link Stream}
200200
*
201+
* @implNote The default implementation defined here simply returns
202+
* {@link #list()}{@link List#stream() .stream()}.
203+
* Overriding implementations are typically more efficient.
204+
*
201205
* @since 5.2
202206
*/
203207
default Stream<R> stream() {
@@ -291,9 +295,9 @@ default Stream<R> stream() {
291295
SelectionQuery<R> setEntityGraph(EntityGraph<R> graph, GraphSemantic semantic);
292296

293297
/**
294-
* Enable the {@link org.hibernate.annotations.FetchProfile fetch profile}
295-
* for this query. If the requested fetch profile is already enabled,
296-
* the call has no effect.
298+
* Enable the {@linkplain org.hibernate.annotations.FetchProfile fetch
299+
* profile} with the given name during execution of this query. If the
300+
* requested fetch profile is already enabled, the call has no effect.
297301
* <p>
298302
* This is an alternative way to specify the associations which
299303
* should be fetched as part of the initial query.
@@ -308,9 +312,9 @@ default Stream<R> stream() {
308312
SelectionQuery<R> enableFetchProfile(String profileName);
309313

310314
/**
311-
* Disable the {@link org.hibernate.annotations.FetchProfile fetch profile}
312-
* with the given name in this session. If the requested fetch profile
313-
* is not currently enabled, the call has no effect.
315+
* Disable the {@linkplain org.hibernate.annotations.FetchProfile fetch
316+
* profile} with the given name in this session. If the fetch profile is
317+
* not currently enabled, the call has no effect.
314318
*
315319
* @param profileName the name of the fetch profile to be disabled
316320
*

0 commit comments

Comments
 (0)