Fix javadocs for ObjectUtil methods.

Motivation:

The javadocs for a few methds in ObjectUtil are not correct.

Modifications:

Add "not" where it was missing.

Result:

Fixes [#7455].
This commit is contained in:
Norman Maurer 2017-12-06 16:14:21 +01:00
parent f921ea344e
commit 27a4e4a3c1

View File

@ -34,7 +34,7 @@ public final class ObjectUtil {
} }
/** /**
* Checks that the given argument is strictly positive. If it is, throws {@link IllegalArgumentException}. * Checks that the given argument is strictly positive. If it is not, throws {@link IllegalArgumentException}.
* Otherwise, returns the argument. * Otherwise, returns the argument.
*/ */
public static int checkPositive(int i, String name) { public static int checkPositive(int i, String name) {
@ -45,7 +45,7 @@ public final class ObjectUtil {
} }
/** /**
* Checks that the given argument is strictly positive. If it is, throws {@link IllegalArgumentException}. * Checks that the given argument is strictly positive. If it is not, throws {@link IllegalArgumentException}.
* Otherwise, returns the argument. * Otherwise, returns the argument.
*/ */
public static long checkPositive(long i, String name) { public static long checkPositive(long i, String name) {
@ -56,7 +56,7 @@ public final class ObjectUtil {
} }
/** /**
* Checks that the given argument is positive or zero. If it is, throws {@link IllegalArgumentException}. * Checks that the given argument is positive or zero. If it is not , throws {@link IllegalArgumentException}.
* Otherwise, returns the argument. * Otherwise, returns the argument.
*/ */
public static int checkPositiveOrZero(int i, String name) { public static int checkPositiveOrZero(int i, String name) {
@ -67,7 +67,7 @@ public final class ObjectUtil {
} }
/** /**
* Checks that the given argument is positive or zero. If it is, throws {@link IllegalArgumentException}. * Checks that the given argument is positive or zero. If it is not, throws {@link IllegalArgumentException}.
* Otherwise, returns the argument. * Otherwise, returns the argument.
*/ */
public static long checkPositiveOrZero(long i, String name) { public static long checkPositiveOrZero(long i, String name) {