Skip to content

Commit 1dc29b9

Browse files
committed
Fix documentation for functional interfaces
1 parent 042998c commit 1dc29b9

17 files changed

+212
-16
lines changed

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner10.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,26 @@
3131
* <p>
3232
* If any validation fails, all errors are accumulated in the final {@code Err} result.
3333
*
34+
* @param <T1> the type of the first result's success value
35+
* @param <T2> the type of the second result's success value
36+
* @param <T3> the type of the third result's success value
37+
* @param <T4> the type of the fourth result's success value
38+
* @param <T5> the type of the fifth result's success value
39+
* @param <T6> the type of the sixth result's success value
40+
* @param <T7> the type of the seventh result's success value
41+
* @param <T8> the type of the eighth result's success value
42+
* @param <T9> the type of the ninth result's success value
43+
* @param <T10> the type of the tenth result's success value
44+
* @param result1 the first result to combine
45+
* @param result2 the second result to combine
46+
* @param result3 the third result to combine
47+
* @param result4 the fourth result to combine
48+
* @param result5 the fifth result to combine
49+
* @param result6 the sixth result to combine
50+
* @param result7 the seventh result to combine
51+
* @param result8 the eighth result to combine
52+
* @param result9 the ninth result to combine
53+
* @param result10 the tenth result to combine
3454
* @see Result#and(Result)
3555
*/
3656
public record ResultCombiner10<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object, T5 extends @Nullable Object, T6 extends @Nullable Object, T7 extends @Nullable Object, T8 extends @Nullable Object, T9 extends @Nullable Object, T10 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner2.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323
* <p>
2424
* If any validation fails, all errors are accumulated in the final {@code Err} result.
2525
*
26+
* @param <T1> the type of the first result's success value
27+
* @param <T2> the type of the second result's success value
28+
* @param result1 the first result to combine
29+
* @param result2 the second result to combine
2630
* @see Result#and(Result)
2731
*/
2832
public record ResultCombiner2<T1 extends @Nullable Object, T2 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner3.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@
2424
* <p>
2525
* If any validation fails, all errors are accumulated in the final {@code Err} result.
2626
*
27+
* @param <T1> the type of the first result's success value
28+
* @param <T2> the type of the second result's success value
29+
* @param <T3> the type of the third result's success value
30+
* @param result1 the first result to combine
31+
* @param result2 the second result to combine
32+
* @param result3 the third result to combine
2733
* @see Result#and(Result)
2834
*/
2935
public record ResultCombiner3<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner4.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@
2525
* <p>
2626
* If any validation fails, all errors are accumulated in the final {@code Err} result.
2727
*
28+
* @param <T1> the type of the first result's success value
29+
* @param <T2> the type of the second result's success value
30+
* @param <T3> the type of the third result's success value
31+
* @param <T4> the type of the fourth result's success value
32+
* @param result1 the first result to combine
33+
* @param result2 the second result to combine
34+
* @param result3 the third result to combine
35+
* @param result4 the fourth result to combine
2836
* @see Result#and(Result)
2937
*/
3038
public record ResultCombiner4<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner5.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@
2626
* <p>
2727
* If any validation fails, all errors are accumulated in the final {@code Err} result.
2828
*
29+
* @param <T1> the type of the first result's success value
30+
* @param <T2> the type of the second result's success value
31+
* @param <T3> the type of the third result's success value
32+
* @param <T4> the type of the fourth result's success value
33+
* @param <T5> the type of the fifth result's success value
34+
* @param result1 the first result to combine
35+
* @param result2 the second result to combine
36+
* @param result3 the third result to combine
37+
* @param result4 the fourth result to combine
38+
* @param result5 the fifth result to combine
2939
* @see Result#and(Result)
3040
*/
3141
public record ResultCombiner5<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object, T5 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner6.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@
2727
* <p>
2828
* If any validation fails, all errors are accumulated in the final {@code Err} result.
2929
*
30+
* @param <T1> the type of the first result's success value
31+
* @param <T2> the type of the second result's success value
32+
* @param <T3> the type of the third result's success value
33+
* @param <T4> the type of the fourth result's success value
34+
* @param <T5> the type of the fifth result's success value
35+
* @param <T6> the type of the sixth result's success value
36+
* @param result1 the first result to combine
37+
* @param result2 the second result to combine
38+
* @param result3 the third result to combine
39+
* @param result4 the fourth result to combine
40+
* @param result5 the fifth result to combine
41+
* @param result6 the sixth result to combine
3042
* @see Result#and(Result)
3143
*/
3244
public record ResultCombiner6<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object, T5 extends @Nullable Object, T6 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner7.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,20 @@
2828
* <p>
2929
* If any validation fails, all errors are accumulated in the final {@code Err} result.
3030
*
31+
* @param <T1> the type of the first result's success value
32+
* @param <T2> the type of the second result's success value
33+
* @param <T3> the type of the third result's success value
34+
* @param <T4> the type of the fourth result's success value
35+
* @param <T5> the type of the fifth result's success value
36+
* @param <T6> the type of the sixth result's success value
37+
* @param <T7> the type of the seventh result's success value
38+
* @param result1 the first result to combine
39+
* @param result2 the second result to combine
40+
* @param result3 the third result to combine
41+
* @param result4 the fourth result to combine
42+
* @param result5 the fifth result to combine
43+
* @param result6 the sixth result to combine
44+
* @param result7 the seventh result to combine
3145
* @see Result#and(Result)
3246
*/
3347
public record ResultCombiner7<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object, T5 extends @Nullable Object, T6 extends @Nullable Object, T7 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner8.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,22 @@
2929
* <p>
3030
* If any validation fails, all errors are accumulated in the final {@code Err} result.
3131
*
32+
* @param <T1> the type of the first result's success value
33+
* @param <T2> the type of the second result's success value
34+
* @param <T3> the type of the third result's success value
35+
* @param <T4> the type of the fourth result's success value
36+
* @param <T5> the type of the fifth result's success value
37+
* @param <T6> the type of the sixth result's success value
38+
* @param <T7> the type of the seventh result's success value
39+
* @param <T8> the type of the eighth result's success value
40+
* @param result1 the first result to combine
41+
* @param result2 the second result to combine
42+
* @param result3 the third result to combine
43+
* @param result4 the fourth result to combine
44+
* @param result5 the fifth result to combine
45+
* @param result6 the sixth result to combine
46+
* @param result7 the seventh result to combine
47+
* @param result8 the eighth result to combine
3248
* @see Result#and(Result)
3349
*/
3450
public record ResultCombiner8<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object, T5 extends @Nullable Object, T6 extends @Nullable Object, T7 extends @Nullable Object, T8 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/combiner/ResultCombiner9.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,24 @@
3030
* <p>
3131
* If any validation fails, all errors are accumulated in the final {@code Err} result.
3232
*
33+
* @param <T1> the type of the first result's success value
34+
* @param <T2> the type of the second result's success value
35+
* @param <T3> the type of the third result's success value
36+
* @param <T4> the type of the fourth result's success value
37+
* @param <T5> the type of the fifth result's success value
38+
* @param <T6> the type of the sixth result's success value
39+
* @param <T7> the type of the seventh result's success value
40+
* @param <T8> the type of the eighth result's success value
41+
* @param <T9> the type of the ninth result's success value
42+
* @param result1 the first result to combine
43+
* @param result2 the second result to combine
44+
* @param result3 the third result to combine
45+
* @param result4 the fourth result to combine
46+
* @param result5 the fifth result to combine
47+
* @param result6 the sixth result to combine
48+
* @param result7 the seventh result to combine
49+
* @param result8 the eighth result to combine
50+
* @param result9 the ninth result to combine
3351
* @see Result#and(Result)
3452
*/
3553
public record ResultCombiner9<T1 extends @Nullable Object, T2 extends @Nullable Object, T3 extends @Nullable Object, T4 extends @Nullable Object, T5 extends @Nullable Object, T6 extends @Nullable Object, T7 extends @Nullable Object, T8 extends @Nullable Object, T9 extends @Nullable Object>(

src/main/java/io/github/raniagus/javalidation/function/DecaFunction.java

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,16 @@
1616
* (a, b, c, d, e, f, g, h, i, j) -> String.format("Combined result", a, b, c, d, e, f, g, h, i, j);
1717
* }</pre>
1818
*
19-
* @param <A> <B> <C> <D> <E> <F> <G> <H> <I> <J>> the types of the input arguments
19+
* @param <A> the type of the first argument
20+
* @param <B> the type of the second argument
21+
* @param <C> the type of the third argument
22+
* @param <D> the type of the fourth argument
23+
* @param <E> the type of the fifth argument
24+
* @param <F> the type of the sixth argument
25+
* @param <G> the type of the seventh argument
26+
* @param <H> the type of the eighth argument
27+
* @param <I> the type of the ninth argument
28+
* @param <J> the type of the tenth argument
2029
* @param <R> the type of the result
2130
* @see Function
2231
* @see java.util.function.BiFunction
@@ -26,7 +35,16 @@ public interface DecaFunction<A extends @Nullable Object, B extends @Nullable Ob
2635
/**
2736
* Applies this function to the given arguments.
2837
*
29-
* @param a, b, c, d, e, f, g, h, i, j the function arguments
38+
* @param a the first function argument
39+
* @param b the second function argument
40+
* @param c the third function argument
41+
* @param d the fourth function argument
42+
* @param e the fifth function argument
43+
* @param f the sixth function argument
44+
* @param g the seventh function argument
45+
* @param h the eighth function argument
46+
* @param i the ninth function argument
47+
* @param j the tenth function argument
3048
* @return the function result
3149
*/
3250
R apply(A a, B b, C c, D d, E e, F f, G g, H h, I i, J j);

0 commit comments

Comments
 (0)