slightly cleaning up ValidationException, using constructor with default keyword="type" for reporting type failures

Author: erosb

core/src/main/java/org/everit/json/schema/ArraySchema.java

@@ -278,7 +278,7 @@ public void validate(final Object subject) {
     List<ValidationException> failures = new ArrayList<>();
     if (!(subject instanceof JSONArray)) {
       if (requiresArray) {
-        throw new ValidationException(this, JSONArray.class, subject, "type");
+        throw new ValidationException(this, JSONArray.class, subject);
       }
     } else {
       JSONArray arrSubject = (JSONArray) subject;

core/src/main/java/org/everit/json/schema/BooleanSchema.java

@@ -45,7 +45,7 @@ public BooleanSchema(final Builder builder) {
   @Override
   public void validate(final Object subject) {
     if (!(subject instanceof Boolean)) {
-      throw new ValidationException(this, Boolean.class, subject, "type");
+      throw new ValidationException(this, Boolean.class, subject);
     }
   }
 

core/src/main/java/org/everit/json/schema/NumberSchema.java

@@ -126,10 +126,10 @@ private void checkMaximum(final double subject) {
     if (maximum != null) {
       if (exclusiveMaximum && maximum.doubleValue() <= subject) {
         throw new ValidationException(this, subject + " is not lower than " + maximum,
-                "exclusiveMaximum");
+            "exclusiveMaximum");
       } else if (maximum.doubleValue() < subject) {
         throw new ValidationException(this, subject + " is not lower or equal to " + maximum,
-                "maximum");
+            "maximum");
       }
     }
   }
@@ -138,10 +138,10 @@ private void checkMinimum(final double subject) {
     if (minimum != null) {
       if (exclusiveMinimum && subject <= minimum.doubleValue()) {
         throw new ValidationException(this, subject + " is not higher than " + minimum,
-                "exclusiveMinimum");
+            "exclusiveMinimum");
       } else if (subject < minimum.doubleValue()) {
         throw new ValidationException(this, subject + " is not higher or equal to " + minimum,
-                "minimum");
+            "minimum");
       }
     }
   }
@@ -152,7 +152,7 @@ private void checkMultipleOf(final double subject) {
           BigDecimal.valueOf(multipleOf.doubleValue()));
       if (remainder.compareTo(BigDecimal.ZERO) != 0) {
         throw new ValidationException(this, subject + " is not a multiple of " + multipleOf,
-                "multipleOf");
+            "multipleOf");
       }
     }
   }
@@ -185,7 +185,7 @@ public boolean requiresInteger() {
   public void validate(final Object subject) {
     if (!(subject instanceof Number)) {
       if (requiresNumber) {
-        throw new ValidationException(this, Number.class, subject, "type");
+        throw new ValidationException(this, Number.class, subject);
       }
     } else {
       if (!(subject instanceof Integer || subject instanceof Long) && requiresInteger) {

core/src/main/java/org/everit/json/schema/ObjectSchema.java

@@ -376,7 +376,7 @@ private List<ValidationException> testSize(final JSONObject subject) {
   public void validate(final Object subject) {
     if (!(subject instanceof JSONObject)) {
       if (requiresObject) {
-        throw new ValidationException(this, JSONObject.class, subject, "type");
+        throw new ValidationException(this, JSONObject.class, subject);
       }
     } else {
       List<ValidationException> failures = new ArrayList<>();

core/src/main/java/org/everit/json/schema/StringSchema.java

@@ -160,7 +160,7 @@ private List<ValidationException> testPattern(final String subject) {
   public void validate(final Object subject) {
     if (!(subject instanceof String)) {
       if (requiresString) {
-        throw new ValidationException(this, String.class, subject, "type");
+        throw new ValidationException(this, String.class, subject);
       }
     } else {
       String stringSubject = (String) subject;

core/src/main/java/org/everit/json/schema/ValidationException.java

@@ -84,7 +84,7 @@ public ValidationException(final Class<?> expectedType, final Object actualValue
   }
 
   /**
-   * Constructor.
+   * Constructor, creates an instance with {@code keyword="type"}.
    *
    * @param violatedSchema
    *          the schema instance which detected the schema violation
@@ -95,14 +95,12 @@ public ValidationException(final Class<?> expectedType, final Object actualValue
    */
   public ValidationException(final Schema violatedSchema, final Class<?> expectedType,
       final Object actualValue) {
-    this(violatedSchema, new StringBuilder("#"),
-        "expected type: " + expectedType.getSimpleName() + ", found: "
-            + (actualValue == null ? "null" : actualValue.getClass().getSimpleName()),
-        Collections.emptyList());
+    this(violatedSchema, expectedType, actualValue, "type");
   }
 
   /**
-   * Constructor.
+   * Constructor for type-mismatch failures. It is usually more convenient to use
+   * {@link #ValidationException(Schema, Class, Object)} instead.
    *
    * @param violatedSchema
    *          the schema instance which detected the schema violation
@@ -135,7 +133,9 @@ private ValidationException(final Schema rootFailingSchema,
    *          the schema instance which detected the schema violation
    * @param message
    *          the readable exception message
+   * @deprecated use one of the constructors which explicitly specify the violated keyword instead
    */
+  @Deprecated
   public ValidationException(final Schema violatedSchema, final String message) {
     this(violatedSchema, new StringBuilder("#"), message, Collections.emptyList());
   }
@@ -231,6 +231,19 @@ private ValidationException(final StringBuilder pointerToViolation,
     this(violatedSchema, pointerToViolation, message, causingExceptions, keyword);
   }
 
+  /**
+   * Constructor.
+   *
+   * @param violatedSchema
+   *          the schema instance which detected the schema violation
+   * @param message
+   *          the readable exception message
+   * @param causingExceptions
+   *          a (possibly empty) list of validation failures. It is used if multiple schema
+   *          violations are found by violatedSchema
+   * @deprecated use one of the constructors which explicitly specify the keyword instead
+   */
+  @Deprecated
   public ValidationException(final Schema violatedSchema, final String message,
       final List<ValidationException> causingExceptions) {
     this(violatedSchema, new StringBuilder("#"), message, causingExceptions);

core/src/test/java/org/everit/json/schema/ValidationExceptionTest.java

@@ -69,7 +69,8 @@ public void nullPointerFragmentFailure() {
 
   @Test
   public void prependNoSchemaChange() {
-    ValidationException exc = new ValidationException(BooleanSchema.INSTANCE, Boolean.class, 2, "type");
+    ValidationException exc =
+        new ValidationException(BooleanSchema.INSTANCE, Boolean.class, 2);
     ValidationException changedExc = exc.prepend("frag");
     Assert.assertEquals("#/frag", changedExc.getPointerToViolation());
     Assert.assertEquals("type", changedExc.getKeyword());
@@ -78,7 +79,7 @@ public void prependNoSchemaChange() {
 
   @Test
   public void prependPointer() {
-    ValidationException exc = new ValidationException(BooleanSchema.INSTANCE, Boolean.class, 2, "type");
+    ValidationException exc = new ValidationException(BooleanSchema.INSTANCE, Boolean.class, 2);
     ValidationException changedExc = exc.prepend("frag", NullSchema.INSTANCE);
     Assert.assertEquals("#/frag", changedExc.getPointerToViolation());
     Assert.assertEquals("type", changedExc.getKeyword());