You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by pa...@apache.org on 2016/09/15 16:38:31 UTC

[lang] LANG-1134: New methods for lang3.Validate (closes #190)

Repository: commons-lang
Updated Branches:
  refs/heads/master dad86bc0a -> 9c5062791


LANG-1134: New methods for lang3.Validate (closes #190)

Fixed method names; fixed differentObject to use Object.equals


Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/9c506279
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/9c506279
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/9c506279

Branch: refs/heads/master
Commit: 9c506279188a90dbbe124386cc52016682d17b5c
Parents: dad86bc
Author: Lady-Stardust <>
Authored: Wed Sep 14 00:45:07 2016 +0200
Committer: pascalschumacher <pa...@gmx.net>
Committed: Thu Sep 15 18:29:03 2016 +0200

----------------------------------------------------------------------
 .../java/org/apache/commons/lang3/Validate.java | 88 ++++++++++----------
 .../org/apache/commons/lang3/ValidateTest.java  | 56 ++++++-------
 2 files changed, 72 insertions(+), 72 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-lang/blob/9c506279/src/main/java/org/apache/commons/lang3/Validate.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/Validate.java b/src/main/java/org/apache/commons/lang3/Validate.java
index 5794560..b70ddd5 100644
--- a/src/main/java/org/apache/commons/lang3/Validate.java
+++ b/src/main/java/org/apache/commons/lang3/Validate.java
@@ -979,7 +979,7 @@ public class Validate {
      * <p>Validates that the specified argument is strictly greater than a given
      * reference; otherwise throwing an exception.</p>
      *
-     * <pre>Validate.greaterObj(myObject, refObject);</pre>
+     * <pre>Validate.greaterObject(myObject, refObject);</pre>
      *
      * <p>The message of the exception is &quot;The value {@code value} is not
      * greater than {@code min}&quot;.</p>
@@ -988,19 +988,19 @@ public class Validate {
      * @param value  the object to validate
      * @param min  the reference value
      * @throws IllegalArgumentException if {@code value} is smaller than or equal to {@code min}
-     * @see #greaterObj(java.lang.Comparable, java.lang.Object, java.lang.String, java.lang.Object...)
-     *
+     * @see #greaterObject(java.lang.Object, java.lang.Comparable, java.lang.String, java.lang.Object...) 
+     * 
      * @since 3.5
      */
-    public static <T> void greaterObj(final Comparable<T> value, final T min) {
-        greaterObj(value, min, DEFAULT_GREATER_EX_MESSAGE, value, min);
+    public static <T> void greaterObject(final Comparable<T> value, final T min) {
+        greaterObject(value, min, DEFAULT_GREATER_EX_MESSAGE, value, min);
     }
 
     /**
      * <p>Validates that the specified argument is strictly greater than a given
      * reference; otherwise throwing an exception with the specified message.</p>
      *
-     * <pre>Validate.greaterObj(myObject, refObject, "The value must be greater than the reference");</pre>
+     * <pre>Validate.greaterObject(myObject, refObject, "The value must be greater than the reference");</pre>
      *
      * @param <T>  the type of the argument object
      * @param value  the object to validate
@@ -1008,11 +1008,11 @@ public class Validate {
      * @param message  the {@link String#format(String, Object...)} exception message if invalid, not null
      * @param values  the optional values for the formatted exception message
      * @throws IllegalArgumentException if {@code value} is smaller than or equal to {@code min}
-     * @see #greaterObj(java.lang.Comparable, java.lang.Object)
-     *
+     * @see #greaterObject(java.lang.Object, java.lang.Comparable) 
+     * 
      * @since 3.5
      */
-    public static <T> void greaterObj(final Comparable<T> value, final T min, final String message, final Object... values) {
+    public static <T> void greaterObject(final Comparable<T> value, final T min, final String message, final Object... values) {
         if (value.compareTo(min) <= 0) {
             throw new IllegalArgumentException(String.format(message, values));
         }
@@ -1113,7 +1113,7 @@ public class Validate {
      * <p>Validates that the specified argument is greater than, or equal to, a
      * given reference; otherwise throwing an exception.</p>
      *
-     * <pre>Validate.greaterOrEqualObj(myObject, refObject);</pre>
+     * <pre>Validate.greaterOrEqualObject(myObject, refObject);</pre>
      *
      * <p>The message of the exception is &quot;The value {@code value} is not
      * greater than or equal to {@code min}&quot;.</p>
@@ -1122,19 +1122,19 @@ public class Validate {
      * @param value  the object to validate
      * @param min  the reference value
      * @throws IllegalArgumentException if {@code value} is smaller than {@code min}
-     * @see #greaterOrEqualObj(java.lang.Comparable, java.lang.Object, java.lang.String, java.lang.Object...)
-     *
+     * @see #greaterOrEqualObject(java.lang.Object, java.lang.Comparable, java.lang.String, java.lang.Object...) 
+     * 
      * @since 3.5
      */
-    public static <T> void greaterOrEqualObj(final Comparable<T> value, final T min) {
-        greaterOrEqualObj(value, min, DEFAULT_GREATER_OR_EQUAL_EX_MESSAGE, value, min);
+    public static <T> void greaterOrEqualObject(final Comparable<T> value, final T min) {
+        greaterOrEqualObject(value, min, DEFAULT_GREATER_OR_EQUAL_EX_MESSAGE, value, min);
     }
 
     /**
      * <p>Validates that the specified argument is greater than, or equal to, a
      * given reference; otherwise throwing an exception.</p>
      *
-     * <pre>Validate.greaterOrEqualObj(myObject, refObject, "The value must be greater than the reference");</pre>
+     * <pre>Validate.greaterOrEqualObject(myObject, refObject, "The value must be greater than the reference");</pre>
      *
      * @param <T>  the type of the argument object
      * @param value  the object to validate
@@ -1142,11 +1142,11 @@ public class Validate {
      * @param message  the {@link String#format(String, Object...)} exception message if invalid, not null
      * @param values  the optional values for the formatted exception message
      * @throws IllegalArgumentException if {@code value} is smaller than {@code min}
-     * @see #greaterOrEqualObj(java.lang.Comparable, java.lang.Object)
-     *
+     * @see #greaterOrEqualObject(java.lang.Object, java.lang.Comparable) 
+     * 
      * @since 3.5
      */
-    public static <T> void greaterOrEqualObj(final Comparable<T> value, final T min, final String message, final Object... values) {
+    public static <T> void greaterOrEqualObject(final Comparable<T> value, final T min, final String message, final Object... values) {
         if (value.compareTo(min) < 0) {
             throw new IllegalArgumentException(String.format(message, values));
         }
@@ -1247,7 +1247,7 @@ public class Validate {
      * <p>Validates that the specified argument is strictly smaller than a given
      * reference; otherwise throwing an exception.</p>
      *
-     * <pre>Validate.smallerObj(myObject, refObject);</pre>
+     * <pre>Validate.smallerObject(myObject, refObject);</pre>
      *
      * <p>The message of the exception is &quot;The value {@code value} is not
      * smaller than {@code max}&quot;.</p>
@@ -1256,19 +1256,19 @@ public class Validate {
      * @param value  the object to validate
      * @param max  the reference value
      * @throws IllegalArgumentException if {@code value} is greater than or equal to {@code max}
-     * @see #smallerObj(java.lang.Comparable, java.lang.Object, java.lang.String, java.lang.Object...)
-     *
+     * @see #smallerObject(java.lang.Object, java.lang.Comparable, java.lang.String, java.lang.Object...) 
+     * 
      * @since 3.5
      */
-    public static <T> void smallerObj(final Comparable<T> value, final T max) {
-        smallerObj(value, max, DEFAULT_SMALLER_EX_MESSAGE, value, max);
+    public static <T> void smallerObject(final Comparable<T> value, final T max) {
+        smallerObject(value, max, DEFAULT_SMALLER_EX_MESSAGE, value, max);
     }
 
     /**
      * <p>Validates that the specified argument is strictly smaller than a given
      * reference; otherwise throwing an exception with the specified message.</p>
      *
-     * <pre>Validate.smallerObj(myObject, refObject, "The value must be greater than the reference");</pre>
+     * <pre>Validate.smallerObject(myObject, refObject, "The value must be greater than the reference");</pre>
      *
      * @param <T>  the type of the argument object
      * @param value  the object to validate
@@ -1276,11 +1276,11 @@ public class Validate {
      * @param message  the {@link String#format(String, Object...)} exception message if invalid, not null
      * @param values  the optional values for the formatted exception message
      * @throws IllegalArgumentException if {@code value} is greater than or equal to {@code max}
-     * @see #smallerObj(java.lang.Comparable, java.lang.Object)
-     *
+     * @see #smallerObject(java.lang.Object, java.lang.Comparable) 
+     * 
      * @since 3.5
      */
-    public static <T> void smallerObj(final Comparable<T> value, final T max, final String message, final Object... values) {
+    public static <T> void smallerObject(final Comparable<T> value, final T max, final String message, final Object... values) {
         if (value.compareTo(max) >= 0) {
             throw new IllegalArgumentException(String.format(message, values));
         }
@@ -1381,7 +1381,7 @@ public class Validate {
      * <p>Validates that the specified argument is smaller than, or equal to, a
      * given reference; otherwise throwing an exception.</p>
      *
-     * <pre>Validate.smallerOrEqualObj(myObject, refObject);</pre>
+     * <pre>Validate.smallerOrEqualObject(myObject, refObject);</pre>
      *
      * <p>The message of the exception is &quot;The value {@code value} is not
      * smaller than or equal to {@code max}&quot;.</p>
@@ -1390,19 +1390,19 @@ public class Validate {
      * @param value  the object to validate
      * @param max  the reference value
      * @throws IllegalArgumentException if {@code value} is greater than {@code max}
-     * @see #smallerOrEqualObj(java.lang.Comparable, java.lang.Object, java.lang.String, java.lang.Object...)
-     *
+     * @see #smallerOrEqualObject(java.lang.Object, java.lang.Comparable, java.lang.String, java.lang.Object...) 
+     * 
      * @since 3.5
      */
-    public static <T> void smallerOrEqualObj(final Comparable<T> value, final T max) {
-        smallerOrEqualObj(value, max, DEFAULT_SMALLER_OR_EQUAL_EX_MESSAGE, value, max);
+    public static <T> void smallerOrEqualObject(final Comparable<T> value, final T max) {
+        smallerOrEqualObject(value, max, DEFAULT_SMALLER_OR_EQUAL_EX_MESSAGE, value, max);
     }
 
     /**
      * <p>Validates that the specified argument is smaller than, or equal to, a
      * given reference; otherwise throwing an exception with the specified message.</p>
      *
-     * <pre>Validate.smallerOrEqualObj(myObject, refObject, "The value must be greater than the reference");</pre>
+     * <pre>Validate.smallerOrEqualObject(myObject, refObject, "The value must be greater than the reference");</pre>
      *
      * @param <T>  the type of the argument object
      * @param value  the object to validate
@@ -1410,11 +1410,11 @@ public class Validate {
      * @param message  the {@link String#format(String, Object...)} exception message if invalid, not null
      * @param values  the optional values for the formatted exception message
      * @throws IllegalArgumentException if {@code value} is greater than {@code max}
-     * @see #smallerOrEqualObj(java.lang.Comparable, java.lang.Object)
-     *
+     * @see #smallerOrEqualObject(java.lang.Object, java.lang.Comparable) 
+     * 
      * @since 3.5
      */
-    public static <T> void smallerOrEqualObj(final Comparable<T> value, final T max, final String message, final Object... values) {
+    public static <T> void smallerOrEqualObject(final Comparable<T> value, final T max, final String message, final Object... values) {
         if (value.compareTo(max) > 0) {
             throw new IllegalArgumentException(String.format(message, values));
         }
@@ -1516,9 +1516,9 @@ public class Validate {
      * (reference); otherwise throwing an exception.</p>
      *
      * <p>Two objects are considered different if
-     * {@code value.compareTo(reference) != 0}</p>
+     * {@code value.equals(reference) == false}</p>
      *
-     * <pre>Validate.differentObj(myObject, refObject);</pre>
+     * <pre>Validate.differentObject(myObject, refObject);</pre>
      *
      * <p>The message of the exception is &quot;The value {@code value} is
      * invalid&quot;.</p>
@@ -1530,8 +1530,8 @@ public class Validate {
      *
      * @since 3.5
      */
-    public static <T> void differentObj(final Comparable<T> value, final T reference) {
-        differentObj(value, reference, DEFAULT_DIFFERENT_EX_MESSAGE, value);
+    public static <T> void differentObject(final T value, final T reference) {
+        differentObject(value, reference, DEFAULT_DIFFERENT_EX_MESSAGE, value);
     }
 
     /**
@@ -1539,9 +1539,9 @@ public class Validate {
      * (reference); otherwise throwing an exception with the specified message.</p>
      *
      * <p>Two objects are considered different if
-     * {@code value.compareTo(reference) != 0}</p>
+     * {@code value.equals(reference) == false}</p>
      *
-     * <pre>Validate.differentObj(myObject, refObject, "The value is invalid");</pre>
+     * <pre>Validate.differentObject(myObject, refObject, "The value is invalid");</pre>
      *
      * @param <T>  the type of the argument object
      * @param value  the object to validate
@@ -1552,8 +1552,8 @@ public class Validate {
      *
      * @since 3.5
      */
-    public static <T> void differentObj(final Comparable<T> value, final T reference, final String message, final Object... values) {
-        if (value.compareTo(reference) == 0) {
+    public static <T> void differentObject(final T value, final T reference, final String message, final Object... values) {
+        if (value.equals(reference)) {
             throw new IllegalArgumentException(String.format(message, values));
         }
     }

http://git-wip-us.apache.org/repos/asf/commons-lang/blob/9c506279/src/test/java/org/apache/commons/lang3/ValidateTest.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/lang3/ValidateTest.java b/src/test/java/org/apache/commons/lang3/ValidateTest.java
index d577ee6..bb294bb 100644
--- a/src/test/java/org/apache/commons/lang3/ValidateTest.java
+++ b/src/test/java/org/apache/commons/lang3/ValidateTest.java
@@ -914,15 +914,15 @@ public class ValidateTest  {
 
     @Test
     public void testGreaterObject1() {
-        Validate.greaterObj("c", "b");
+        Validate.greaterObject("c", "b");
         try {
-            Validate.greaterObj("b", "b");
+            Validate.greaterObject("b", "b");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value b is not greater than b", ex.getMessage());
         }
         try {
-            Validate.greaterObj("a", "b");
+            Validate.greaterObject("a", "b");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value a is not greater than b", ex.getMessage());
@@ -931,15 +931,15 @@ public class ValidateTest  {
 
     @Test
     public void testGreaterObject2() {
-        Validate.greaterObj("c", "b", "MSG");
+        Validate.greaterObject("c", "b", "MSG");
         try {
-            Validate.greaterObj("b", "b", "MSG");
+            Validate.greaterObject("b", "b", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());
         }
         try {
-            Validate.greaterObj("a", "b", "MSG");
+            Validate.greaterObject("a", "b", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());
@@ -1057,10 +1057,10 @@ public class ValidateTest  {
 
     @Test
     public void testGreaterOrEqualObject1() {
-        Validate.greaterOrEqualObj("c", "b");
-        Validate.greaterOrEqualObj("b", "b");
+        Validate.greaterOrEqualObject("c", "b");
+        Validate.greaterOrEqualObject("b", "b");
         try {
-            Validate.greaterOrEqualObj("a", "b");
+            Validate.greaterOrEqualObject("a", "b");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value a is not greater than or equal to b", ex.getMessage());
@@ -1069,10 +1069,10 @@ public class ValidateTest  {
 
     @Test
     public void testGreaterOrEqualObject2() {
-        Validate.greaterOrEqualObj("c", "b", "MSG");
-        Validate.greaterOrEqualObj("b", "b", "MSG");
+        Validate.greaterOrEqualObject("c", "b", "MSG");
+        Validate.greaterOrEqualObject("b", "b", "MSG");
         try {
-            Validate.greaterOrEqualObj("a", "b", "MSG");
+            Validate.greaterOrEqualObject("a", "b", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());
@@ -1183,15 +1183,15 @@ public class ValidateTest  {
 
     @Test
     public void testSmallerObject1() {
-        Validate.smallerObj("a", "b");
+        Validate.smallerObject("a", "b");
         try {
-            Validate.smallerObj("b", "b");
+            Validate.smallerObject("b", "b");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value b is not smaller than b", ex.getMessage());
         }
         try {
-            Validate.smallerObj("c", "b");
+            Validate.smallerObject("c", "b");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value c is not smaller than b", ex.getMessage());
@@ -1200,15 +1200,15 @@ public class ValidateTest  {
 
     @Test
     public void testSmallerObject2() {
-        Validate.smallerObj("a", "b", "MSG");
+        Validate.smallerObject("a", "b", "MSG");
         try {
-            Validate.smallerObj("b", "b", "MSG");
+            Validate.smallerObject("b", "b", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());
         }
         try {
-            Validate.smallerObj("c", "b", "MSG");
+            Validate.smallerObject("c", "b", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());
@@ -1326,10 +1326,10 @@ public class ValidateTest  {
 
     @Test
     public void testSmallerOrEqualObject1() {
-        Validate.smallerOrEqualObj("a", "b");
-        Validate.smallerOrEqualObj("b", "b");
+        Validate.smallerOrEqualObject("a", "b");
+        Validate.smallerOrEqualObject("b", "b");
         try {
-            Validate.smallerOrEqualObj("c", "b");
+            Validate.smallerOrEqualObject("c", "b");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value c is not smaller than or equal to b", ex.getMessage());
@@ -1338,10 +1338,10 @@ public class ValidateTest  {
 
     @Test
     public void testSmallerOrEqualObject2() {
-        Validate.smallerOrEqualObj("a", "b", "MSG");
-        Validate.smallerOrEqualObj("b", "b", "MSG");
+        Validate.smallerOrEqualObject("a", "b", "MSG");
+        Validate.smallerOrEqualObject("b", "b", "MSG");
         try {
-            Validate.smallerOrEqualObj("c", "b", "MSG");
+            Validate.smallerOrEqualObject("c", "b", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());
@@ -1439,9 +1439,9 @@ public class ValidateTest  {
 
     @Test
     public void testDifferentObject1() {
-        Validate.differentObj("b", "a");
+        Validate.differentObject("b", "a");
         try {
-            Validate.differentObj("a", "a");
+            Validate.differentObject("a", "a");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("The value a is invalid", ex.getMessage());
@@ -1450,9 +1450,9 @@ public class ValidateTest  {
 
     @Test
     public void testDifferentObject2() {
-        Validate.differentObj("b", "a", "MSG");
+        Validate.differentObject("b", "a", "MSG");
         try {
-            Validate.differentObj("a", "a", "MSG");
+            Validate.differentObject("a", "a", "MSG");
             fail("Expecting IllegalArgumentException");
         } catch (final IllegalArgumentException ex) {
             assertEquals("MSG", ex.getMessage());