diff --git a/vavr/generator/Generator.scala b/vavr/generator/Generator.scala index 73925e5938..78ac9d67d8 100644 --- a/vavr/generator/Generator.scala +++ b/vavr/generator/Generator.scala @@ -1670,7 +1670,7 @@ def generateMainClasses(): Unit = { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction0.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction0.java index d4bd501002..30ed001a4a 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction0.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction0.java @@ -143,7 +143,7 @@ static CheckedFunction0 narrow(CheckedFunction0 f) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction1.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction1.java index 42400462d2..37a3916a48 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction1.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction1.java @@ -160,7 +160,7 @@ static CheckedFunction1 identity() { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction2.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction2.java index 227b5a0c99..2e42927c5c 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction2.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction2.java @@ -168,7 +168,7 @@ default CheckedFunction1 apply(T1 t1) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction3.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction3.java index f00a1fbcee..0ce876c19c 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction3.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction3.java @@ -185,7 +185,7 @@ default CheckedFunction1 apply(T1 t1, T2 t2) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction4.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction4.java index 4d8933471d..81653536c2 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction4.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction4.java @@ -204,7 +204,7 @@ default CheckedFunction1 apply(T1 t1, T2 t2, T3 t3) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction5.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction5.java index f5450b9d9e..d37354a6ad 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction5.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction5.java @@ -224,7 +224,7 @@ default CheckedFunction1 apply(T1 t1, T2 t2, T3 t3, T4 t4) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction6.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction6.java index 784462b490..76d0f23652 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction6.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction6.java @@ -245,7 +245,7 @@ default CheckedFunction1 apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction7.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction7.java index 6239d4d20e..6fcf5a5993 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction7.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction7.java @@ -267,7 +267,7 @@ default CheckedFunction1 apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6) /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction8.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction8.java index 2c33e47959..9fb6da3eae 100644 --- a/vavr/src-gen/main/java/io/vavr/CheckedFunction8.java +++ b/vavr/src-gen/main/java/io/vavr/CheckedFunction8.java @@ -290,7 +290,7 @@ default CheckedFunction1 apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function0.java b/vavr/src-gen/main/java/io/vavr/Function0.java index 02d5e80b88..54603db919 100644 --- a/vavr/src-gen/main/java/io/vavr/Function0.java +++ b/vavr/src-gen/main/java/io/vavr/Function0.java @@ -151,7 +151,7 @@ default R get() { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function1.java b/vavr/src-gen/main/java/io/vavr/Function1.java index de30a741f3..0c710e5637 100644 --- a/vavr/src-gen/main/java/io/vavr/Function1.java +++ b/vavr/src-gen/main/java/io/vavr/Function1.java @@ -159,7 +159,7 @@ static Function1 identity() { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function2.java b/vavr/src-gen/main/java/io/vavr/Function2.java index 05e1f26192..268d57c78d 100644 --- a/vavr/src-gen/main/java/io/vavr/Function2.java +++ b/vavr/src-gen/main/java/io/vavr/Function2.java @@ -166,7 +166,7 @@ default Function1 apply(T1 t1) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function3.java b/vavr/src-gen/main/java/io/vavr/Function3.java index 62e67cc691..ae7c7fa5d6 100644 --- a/vavr/src-gen/main/java/io/vavr/Function3.java +++ b/vavr/src-gen/main/java/io/vavr/Function3.java @@ -183,7 +183,7 @@ default Function1 apply(T1 t1, T2 t2) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function4.java b/vavr/src-gen/main/java/io/vavr/Function4.java index 06b31734c3..3f4497ca35 100644 --- a/vavr/src-gen/main/java/io/vavr/Function4.java +++ b/vavr/src-gen/main/java/io/vavr/Function4.java @@ -202,7 +202,7 @@ default Function1 apply(T1 t1, T2 t2, T3 t3) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function5.java b/vavr/src-gen/main/java/io/vavr/Function5.java index 3afdeed1da..3e3deb70b4 100644 --- a/vavr/src-gen/main/java/io/vavr/Function5.java +++ b/vavr/src-gen/main/java/io/vavr/Function5.java @@ -222,7 +222,7 @@ default Function1 apply(T1 t1, T2 t2, T3 t3, T4 t4) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function6.java b/vavr/src-gen/main/java/io/vavr/Function6.java index 9574ccd1f5..5b6682a99f 100644 --- a/vavr/src-gen/main/java/io/vavr/Function6.java +++ b/vavr/src-gen/main/java/io/vavr/Function6.java @@ -243,7 +243,7 @@ default Function1 apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function7.java b/vavr/src-gen/main/java/io/vavr/Function7.java index 829ddcebfd..20e8bf76d2 100644 --- a/vavr/src-gen/main/java/io/vavr/Function7.java +++ b/vavr/src-gen/main/java/io/vavr/Function7.java @@ -265,7 +265,7 @@ default Function1 apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6) { /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src-gen/main/java/io/vavr/Function8.java b/vavr/src-gen/main/java/io/vavr/Function8.java index baf4904485..abdc032171 100644 --- a/vavr/src-gen/main/java/io/vavr/Function8.java +++ b/vavr/src-gen/main/java/io/vavr/Function8.java @@ -288,7 +288,7 @@ default Function1 apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7) /** * Returns the number of function arguments. - * @return an int value >= 0 + * @return an int value >= 0 * @see Arity */ default int arity() { diff --git a/vavr/src/main/java/io/vavr/control/Either.java b/vavr/src/main/java/io/vavr/control/Either.java index bf88493702..c805699ca8 100644 --- a/vavr/src/main/java/io/vavr/control/Either.java +++ b/vavr/src/main/java/io/vavr/control/Either.java @@ -453,7 +453,6 @@ default Option> filter(Predicate predicate) { * If the {@code Either} is a {@code Right} and the predicate doesn't match, the * {@code Either} will be turned into a {@code Left} with contents computed by applying * the filterVal function to the {@code Either} value. - *

* *

{@code
      * import static io.vavr.API.*;
@@ -466,11 +465,11 @@ default Option> filter(Predicate predicate) {
      * }
* * @param predicate A predicate + * @param zero A function that turns a right value into a left value if the right value does not make it through the filter. * @return an {@code Either} instance * @throws NullPointerException if {@code predicate} is null */ - default Either filterOrElse(Predicate predicate, - Function zero) { + default Either filterOrElse(Predicate predicate, Function zero) { Objects.requireNonNull(predicate, "predicate is null"); Objects.requireNonNull(zero, "zero is null"); if (isLeft() || predicate.test(get())) { diff --git a/vavr/src/main/java/io/vavr/control/Try.java b/vavr/src/main/java/io/vavr/control/Try.java index 03fbdd2e4c..f9c7188aed 100644 --- a/vavr/src/main/java/io/vavr/control/Try.java +++ b/vavr/src/main/java/io/vavr/control/Try.java @@ -1009,11 +1009,9 @@ default Validation toValidation() { * Converts this {@code Try} to a {@link Validation}, converting the Throwable (if present) * to another object using passed {@link Function}. * - *
-     * 
+     * 
{@code
      * Validation = Try.of(() -> 1/0).toValidation(Throwable::getMessage));
-     * 
-     * 
+ * }
* * @param result type of the throwable mapper * @param throwableMapper A transformation from throwable to desired invalid type of new {@code Validation} diff --git a/vavr/src/main/java/io/vavr/package-info.java b/vavr/src/main/java/io/vavr/package-info.java index 1c1b2c8b38..6f3e484f16 100644 --- a/vavr/src/main/java/io/vavr/package-info.java +++ b/vavr/src/main/java/io/vavr/package-info.java @@ -1,4 +1,4 @@ /** - * The io.vavr package contains core types like {@linkplain io.vavr.Lambda}, {@linkplain io.vavr.Lazy} and {@linkplain io.vavr.Tuple}. + * Beside {@link io.vavr.API} the io.vavr package contains core types like (Checked)Functions and Tuples. */ package io.vavr;