Skip to content

Commit b182e67

Browse files
SanneSanne
committed
Formatting of javadoc
1 parent adacca0 commit b182e67

File tree

5 files changed

+28
-55
lines changed

5 files changed

+28
-55
lines changed

‎hibernate-reactive-core/src/main/java/org/hibernate/reactive/mutiny/Mutiny.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -758,16 +758,13 @@ default Mutiny.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph g
758758
* to use. If unable to determine an appropriate {@link BindableType},
759759
* {@link #setParameter(int, Object)} is used.
760760
*
761-
* @see BindableType#parameterType(Class)
762761
* @see #setParameter(int, Object, BindableType)
763762
*/
764763
<P> Mutiny.Query<R> setParameter(int parameter, P argument, Class<P> type);
765764

766765
/**
767766
* Bind the given argument to an ordinal query parameter using the given
768767
* {@link BindableType}.
769-
*
770-
* @see BindableType#parameterType
771768
*/
772769
<P> Mutiny.Query<R> setParameter(int parameter, P argument, BindableType<P> type);
773770

@@ -839,7 +836,6 @@ default Mutiny.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph g
839836
* to use. If unable to determine an appropriate {@link BindableType},
840837
* {@link #setParameterList(String, Collection)} is used.
841838
*
842-
* @see BindableType#parameterType(Class)
843839
* @see #setParameterList(java.lang.String, Object[], BindableType)
844840
*
845841
* @apiNote This is used for binding a list of values to an expression
@@ -880,7 +876,6 @@ default Mutiny.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph g
880876
* to use. If unable to determine an appropriate {@link BindableType},
881877
* {@link #setParameterList(String, Collection)} is used.
882878
*
883-
* @see BindableType#parameterType(Class)
884879
* @see #setParameterList(int, Collection, BindableType)
885880
*
886881
* @apiNote This is used for binding a list of values to an expression
@@ -920,7 +915,6 @@ default Mutiny.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph g
920915
* to use. If unable to determine an appropriate {@link BindableType},
921916
* {@link #setParameterList(String, Collection)} is used.
922917
*
923-
* @see BindableType#parameterType(Class)
924918
* @see #setParameterList(int, Object[], BindableType)
925919
*
926920
* @apiNote This is used for binding a list of values to an expression
@@ -962,7 +956,6 @@ default Mutiny.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph g
962956
* appropriate {@link BindableType}, {@link #setParameterList(String, Collection)}
963957
* is used.
964958
*
965-
* @see BindableType#parameterType(Class)
966959
* @see #setParameterList(QueryParameter, java.util.Collection, BindableType)
967960
*
968961
* @apiNote This is used for binding a list of values to an expression such
@@ -1008,7 +1001,6 @@ default Mutiny.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph g
10081001
* determine an appropriate {@link BindableType},
10091002
* {@link #setParameterList(String, Collection)} is used
10101003
*
1011-
* @see BindableType#parameterType(Class)
10121004
* @see #setParameterList(QueryParameter, Object[], BindableType)
10131005
*
10141006
* @apiNote This is used for binding a list of values to an expression such

‎hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/ReactiveQuery.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,13 @@ default ReactiveQuery<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph
109109
* to use. If unable to determine an appropriate {@link BindableType},
110110
* {@link #setParameter(int, Object)} is used.
111111
*
112-
* @see BindableType#parameterType(Class)
113112
* @see #setParameter(int, Object, BindableType)
114113
*/
115114
<P> ReactiveQuery<R> setParameter(int parameter, P argument, Class<P> type);
116115

117116
/**
118117
* Bind the given argument to an ordinal query parameter using the given
119118
* {@link BindableType}.
120-
*
121-
* @see BindableType#parameterType
122119
*/
123120
<P> ReactiveQuery<R> setParameter(int parameter, P argument, BindableType<P> type);
124121

@@ -189,7 +186,6 @@ default ReactiveQuery<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph
189186
* to use. If unable to determine an appropriate {@link BindableType},
190187
* {@link #setParameterList(String, Collection)} is used.
191188
*
192-
* @see BindableType#parameterType(Class)
193189
* @see #setParameterList(java.lang.String, Object[], BindableType)
194190
*
195191
* @apiNote This is used for binding a list of values to an expression
@@ -230,7 +226,6 @@ default ReactiveQuery<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph
230226
* to use. If unable to determine an appropriate {@link BindableType},
231227
* {@link #setParameterList(String, Collection)} is used.
232228
*
233-
* @see BindableType#parameterType(Class)
234229
* @see #setParameterList(int, Collection, BindableType)
235230
*
236231
* @apiNote This is used for binding a list of values to an expression
@@ -270,7 +265,6 @@ default ReactiveQuery<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph
270265
* to use. If unable to determine an appropriate {@link BindableType},
271266
* {@link #setParameterList(String, Collection)} is used.
272267
*
273-
* @see BindableType#parameterType(Class)
274268
* @see #setParameterList(int, Object[], BindableType)
275269
*
276270
* @apiNote This is used for binding a list of values to an expression
@@ -312,7 +306,6 @@ default ReactiveQuery<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph
312306
* appropriate {@link BindableType}, {@link #setParameterList(String, Collection)}
313307
* is used.
314308
*
315-
* @see BindableType#parameterType(Class)
316309
* @see #setParameterList(QueryParameter, java.util.Collection, BindableType)
317310
*
318311
* @apiNote This is used for binding a list of values to an expression such
@@ -358,7 +351,6 @@ default ReactiveQuery<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph
358351
* determine an appropriate {@link BindableType},
359352
* {@link #setParameterList(String, Collection)} is used
360353
*
361-
* @see BindableType#parameterType(Class)
362354
* @see #setParameterList(QueryParameter, Object[], BindableType)
363355
*
364356
* @apiNote This is used for binding a list of values to an expression such

‎hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveExceptionConverter.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@
1212
/**
1313
* Handle exceptions and convert them following the logic used in Hibernate ORM.
1414
* <p>
15-
* Depending on the value of
16-
* {@link org.hibernate.cfg.AvailableSettings#NATIVE_EXCEPTION_HANDLING_51_COMPLIANCE}
17-
* it converts the exception to a {@link HibernateException} or a
15+
* It converts the exception to a {@link HibernateException} or a
1816
* {@link jakarta.persistence.PersistenceException}.
1917
*
2018
* @see org.hibernate.engine.spi.ExceptionConverter
21-
* @see org.hibernate.cfg.AvailableSettings#NATIVE_EXCEPTION_HANDLING_51_COMPLIANCE
2219
*/
2320
public class ReactiveExceptionConverter extends ExceptionConverterImpl {
2421
public ReactiveExceptionConverter(SharedSessionContractImplementor sharedSessionContract) {

‎hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/Stage.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -765,16 +765,13 @@ default Stage.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph gr
765765
* to use. If unable to determine an appropriate {@link BindableType},
766766
* {@link #setParameter(int, Object)} is used.
767767
*
768-
* @see BindableType#parameterType(Class)
769768
* @see #setParameter(int, Object, BindableType)
770769
*/
771770
<P> Stage.Query<R> setParameter(int parameter, P argument, Class<P> type);
772771

773772
/**
774773
* Bind the given argument to an ordinal query parameter using the given
775774
* {@link BindableType}.
776-
*
777-
* @see BindableType#parameterType
778775
*/
779776
<P> Stage.Query<R> setParameter(int parameter, P argument, BindableType<P> type);
780777

@@ -846,7 +843,6 @@ default Stage.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph gr
846843
* to use. If unable to determine an appropriate {@link BindableType},
847844
* {@link #setParameterList(String, Collection)} is used.
848845
*
849-
* @see BindableType#parameterType(Class)
850846
* @see #setParameterList(java.lang.String, Object[], BindableType)
851847
*
852848
* @apiNote This is used for binding a list of values to an expression
@@ -887,7 +883,6 @@ default Stage.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph gr
887883
* to use. If unable to determine an appropriate {@link BindableType},
888884
* {@link #setParameterList(String, Collection)} is used.
889885
*
890-
* @see BindableType#parameterType(Class)
891886
* @see #setParameterList(int, Collection, BindableType)
892887
*
893888
* @apiNote This is used for binding a list of values to an expression
@@ -927,7 +922,6 @@ default Stage.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph gr
927922
* to use. If unable to determine an appropriate {@link BindableType},
928923
* {@link #setParameterList(String, Collection)} is used.
929924
*
930-
* @see BindableType#parameterType(Class)
931925
* @see #setParameterList(int, Object[], BindableType)
932926
*
933927
* @apiNote This is used for binding a list of values to an expression
@@ -969,7 +963,6 @@ default Stage.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph gr
969963
* appropriate {@link BindableType}, {@link #setParameterList(String, Collection)}
970964
* is used.
971965
*
972-
* @see BindableType#parameterType(Class)
973966
* @see #setParameterList(QueryParameter, java.util.Collection, BindableType)
974967
*
975968
* @apiNote This is used for binding a list of values to an expression such
@@ -1015,7 +1008,6 @@ default Stage.Query<R> applyLoadGraph(@SuppressWarnings("rawtypes") RootGraph gr
10151008
* determine an appropriate {@link BindableType},
10161009
* {@link #setParameterList(String, Collection)} is used
10171010
*
1018-
* @see BindableType#parameterType(Class)
10191011
* @see #setParameterList(QueryParameter, Object[], BindableType)
10201012
*
10211013
* @apiNote This is used for binding a list of values to an expression such

‎hibernate-reactive-core/src/main/java/org/hibernate/reactive/util/impl/CompletionStages.java

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,12 @@ public static void logSqlException(Throwable t, Supplier<String> message, String
125125

126126
/**
127127
* Equivalent to:
128-
* <pre>
128+
* <pre>{@code
129129
* int total = 0;
130130
* for ( int i = start; i < end; i++ ) {
131131
* total = total + consumer.apply( i );
132132
* }
133-
* </pre>
133+
* }</pre>
134134
*/
135135
public static CompletionStage<Integer> total(int start, int end, IntFunction<CompletionStage<Integer>> consumer) {
136136
return range( start, end )
@@ -140,12 +140,12 @@ public static CompletionStage<Integer> total(int start, int end, IntFunction<Com
140140

141141
/**
142142
* Equivalent to:
143-
* <pre>
143+
* <pre>{@code
144144
* int total = 0;
145145
* while( iterator.hasNext() ) {
146146
* total += consumer.apply( iterator.next() );
147147
* }
148-
* </pre>
148+
* }</pre>
149149
*/
150150
public static <T> CompletionStage<Integer> total(Iterator<T> iterator, Function<T,CompletionStage<Integer>> consumer) {
151151
return fromIterator( iterator )
@@ -155,58 +155,58 @@ public static <T> CompletionStage<Integer> total(Iterator<T> iterator, Function<
155155

156156
/**
157157
* Equivalent to:
158-
* <pre>
158+
* <pre>{@code
159159
* int total = 0;
160160
* for ( int i = start; i < end; i++ ) {
161161
* total = total + consumer.apply( array[i] );
162162
* }
163-
* </pre>
163+
* }</pre>
164164
*/
165165
public static <T> CompletionStage<Integer> total(T[] array, Function<T, CompletionStage<Integer>> consumer) {
166166
return total( 0, array.length, index -> consumer.apply( array[index] ) );
167167
}
168168

169169
/**
170170
* Equivalent to:
171-
* <pre>
171+
* <pre>{@code
172172
* for ( int i = start; i < end; i++ ) {
173173
* consumer.apply( array[i] );
174174
* }
175-
* </pre>
175+
* }</pre>
176176
*/
177177
public static <T> CompletionStage<Void> loop(T[] array, Function<T, CompletionStage<?>> consumer) {
178178
return loop( 0, array.length, index -> consumer.apply( array[index] ) );
179179
}
180180

181181
/**
182182
* Equivalent to:
183-
* <pre>
183+
* <pre>{@code
184184
* for ( int i = start; i < end; i++ ) {
185185
* if ( filter.test(i) ) {
186186
* consumer.apply( i );
187187
* }
188188
* }
189-
* </pre>
189+
* }</pre>
190190
*/
191191
public static <T> CompletionStage<Void> loop(T[] array, IntPredicate filter, IntFunction<CompletionStage<?>> consumer) {
192192
return loop( 0, array.length, filter, consumer );
193193
}
194194

195195
/**
196196
* Equivalent to:
197-
* <pre>
197+
* <pre>{@code
198198
* int index = 0
199199
* while( iterator.hasNext() ) {
200200
* consumer.apply( iterator.next(), index++ );
201201
* }
202-
* </pre>
202+
* }</pre>
203203
*/
204204
public static <T> CompletionStage<Void> loop(Iterator<T> iterator, IntBiFunction<T, CompletionStage<?>> consumer) {
205205
return loop( iterator, CompletionStages::alwaysTrue, consumer );
206206
}
207207
/**
208208
* Equivalent to:
209-
* <pre>
209+
* <pre>{@code
210210
* int index = -1
211211
* while( iterator.hasNext() ) {
212212
* index++
@@ -215,7 +215,7 @@ public static <T> CompletionStage<Void> loop(Iterator<T> iterator, IntBiFunction
215215
* consumer.apply( next, index );
216216
* }
217217
* }
218-
* </pre>
218+
* }</pre>
219219
*/
220220
public static <T> CompletionStage<Void> loop(Iterator<T> iterator, IntBiPredicate<T> filter, IntBiFunction<T, CompletionStage<?>> consumer) {
221221
if ( iterator.hasNext() ) {
@@ -234,16 +234,16 @@ public static <U> U nullFuture(Void unused) {
234234
* an index of the current element.
235235
* <p>
236236
* Equivalent to:
237-
* <pre>
237+
* <pre>{@code
238238
* int index = -1
239-
* while( iterator.hasNext() ) {
240-
* index++
241-
* T next = iterator.next();
242-
* if (filter.test( next, index ) {
243-
* consumer.apply( next, index );
244-
* }
245-
* }
246-
* </pre>
239+
* while( iterator.hasNext() ) {
240+
* index++
241+
* T next = iterator.next();
242+
* if (filter.test( next, index ) {
243+
* consumer.apply( next, index );
244+
* }
245+
* }
246+
* }</pre>
247247
* </p>
248248
* <p>
249249
* This class keeps track of the state of the loop, allowing us to
@@ -335,11 +335,11 @@ public static <T> CompletionStage<Void> loop(Queue<T> queue, Function<T, Complet
335335

336336
/**
337337
* Equivalent to:
338-
* <pre>
338+
* <pre>{@code
339339
* for ( int i = start; i < end; i++ ) {
340340
* consumer.apply( i );
341341
* }
342-
* </pre>
342+
* }</pre>
343343
*/
344344
public static CompletionStage<Void> loop(int start, int end, IntFunction<CompletionStage<?>> consumer) {
345345
return loop( start, end, CompletionStages::alwaysTrue, consumer );
@@ -359,13 +359,13 @@ public static CompletionStage<Void> whileLoop(int start, int end, IntPredicate f
359359

360360
/**
361361
* Equivalent to:
362-
* <pre>
362+
* <pre>{@code
363363
* for ( int i = start; i < end; i++ ) {
364364
* if ( filter.test(i) ) {
365365
* consumer.apply( i );
366366
* }
367367
* }
368-
* </pre>
368+
* }</pre>
369369
*/
370370
public static CompletionStage<Void> loop(int start, int end, IntPredicate filter, IntFunction<CompletionStage<?>> consumer) {
371371
if ( start < end ) {

0 commit comments

Comments
 (0)