added ValidationExceptionTest#getMessageAfterPrepend() test, added javadoc

Author: erosb

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

@@ -32,16 +32,18 @@ public class ValidationException extends RuntimeException {
    * create {@code ValidationException}s, handling the case of multiple violations occuring during
    * validation.
    *
-   * <p>
    * <ul>
    * <li>If {@code failures} is empty, then it doesn't do anything</li>
    * <li>If {@code failures} contains 1 exception instance, then that will be thrown</li>
    * <li>Otherwise a new exception instance will be created, its {@link #getViolatedSchema()
    * violated schema} will be {@code rootFailingSchema}, and its {@link #getCausingExceptions()
    * causing exceptions} will be the {@code failures} list</li>
    * </ul>
-   * </p>
    *
+   * @param rootFailingSchema
+   *          the schema which detected the {@code failures}
+   * @param failures
+   *          list containing validation failures to be thrown by this method
    */
   public static void throwFor(final Schema rootFailingSchema,
       final List<ValidationException> failures) {
@@ -63,6 +65,11 @@ public static void throwFor(final Schema rootFailingSchema,
 
   /**
    * Deprecated, use {@code ValidationException(Schema, Class<?>, Object)} instead.
+   *
+   * @param expectedType
+   *          the expected type
+   * @param actualValue
+   *          the violating value
    */
   @Deprecated
   public ValidationException(final Class<?> expectedType, final Object actualValue) {
@@ -71,6 +78,13 @@ public ValidationException(final Class<?> expectedType, final Object actualValue
 
   /**
    * Constructor.
+   *
+   * @param violatedSchema
+   *          the schema instance which detected the schema violation
+   * @param expectedType
+   *          the expected type
+   * @param actualValue
+   *          the violating value
    */
   public ValidationException(final Schema violatedSchema, final Class<?> expectedType,
       final Object actualValue) {
@@ -87,12 +101,30 @@ private ValidationException(final Schema rootFailingSchema,
         causingExceptions);
   }
 
+  /**
+   * Constructor.
+   *
+   * @param violatedSchema
+   *          the schema instance which detected the schema violation
+   * @param message
+   *          the readable exception message
+   */
   public ValidationException(final Schema violatedSchema, final String message) {
     this(violatedSchema, new StringBuilder("#"), message, Collections.emptyList());
   }
 
   /***
    * Constructor.
+   *
+   * @param violatedSchema
+   *          the schema instance which detected the schema violation
+   * @param pointerToViolation
+   *          a JSON pointer denoting the part of the document which violates the schema
+   * @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
    */
   public ValidationException(final Schema violatedSchema, final StringBuilder pointerToViolation,
       final String message,
@@ -125,6 +157,11 @@ public List<ValidationException> getCausingExceptions() {
     return causingExceptions;
   }
 
+  @Override
+  public String getMessage() {
+    return getPointerToViolation() + ": " + super.getMessage();
+  }
+
   public String getPointerToViolation() {
     return pointerToViolation.toString();
   }
@@ -162,7 +199,7 @@ public ValidationException prepend(final String fragment, final Schema violatedS
     List<ValidationException> prependedCausingExceptions = causingExceptions.stream()
         .map(exc -> exc.prepend(fragment))
         .collect(Collectors.toList());
-    return new ValidationException(newPointer, violatedSchema, getMessage(),
+    return new ValidationException(newPointer, violatedSchema, super.getMessage(),
         prependedCausingExceptions);
   }
 

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

@@ -88,9 +88,8 @@ public void multipleSchemaDepViolation() {
           .getCausingExceptions().get(1);
       Assert.assertEquals("#/billing_name", billingNameFailure.getPointerToViolation());
       Assert.assertEquals(billingNameSchema, billingNameFailure.getViolatedSchema());
-
       Assert.assertEquals("#", ageFailure.getPointerToViolation());
-      Assert.assertEquals("required key [age] not found", ageFailure.getMessage());
+      Assert.assertEquals("#: required key [age] not found", ageFailure.getMessage());
     }
   }
 

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

@@ -37,6 +37,13 @@ private ValidationException createDummyException(final String pointer) {
         "stuff went wrong", Collections.emptyList());
   }
 
+  @Test
+  public void getMessageAfterPrepend() {
+    ValidationException subject = createDummyException("#/a").prepend("obj");
+    System.out.println(subject.getMessage());
+    Assert.assertEquals("#/obj/a: stuff went wrong", subject.getMessage());
+  }
+
   @Test(expected = NullPointerException.class)
   public void nullPointerFragmentFailure() {
     new ValidationException(BooleanSchema.INSTANCE, Boolean.class, 2).prepend(null,
@@ -92,7 +99,7 @@ public void throwForMultipleFailures() {
       Assert.fail("did not throw exception for 2 input exceptions");
     } catch (ValidationException e) {
       Assert.assertSame(rootSchema, e.getViolatedSchema());
-      Assert.assertEquals("2 schema violations found", e.getMessage());
+      Assert.assertEquals("#: 2 schema violations found", e.getMessage());
       List<ValidationException> causes = e.getCausingExceptions();
       Assert.assertEquals(2, causes.size());
       Assert.assertSame(input1, causes.get(0));