extracting ValidationFailureReporter interface

 * renaming existing `FailureReporter` to `CollectingFailureReporter`
 * renaming `#throwExceptionIfFailureFound()` to `#validationFinished()`

Author: erosb

core/src/main/java/org/everit/json/schema/FailureReporter.java renamed to core/src/main/java/org/everit/json/schema/CollectingFailureReporter.java

@@ -5,33 +5,36 @@
 import java.util.ArrayList;
 import java.util.List;
 
-class FailureReporter {
+class CollectingFailureReporter implements ValidationFailureReporter {
 
     private List<ValidationException> failures = new ArrayList<>(1);
 
     private Schema schema;
 
-    FailureReporter(Schema schema) {
+    CollectingFailureReporter(Schema schema) {
         this.schema = requireNonNull(schema, "schema cannot be null");
     }
 
-    void failure(String message, String keyword) {
+    @Override
+    public void failure(String message, String keyword) {
         failures.add(new ValidationException(schema, message, keyword, schema.getSchemaLocation()));
     }
 
-    void failure(Class<?> expectedType, Object actualValue) {
+    @Override
+    public void failure(Class<?> expectedType, Object actualValue) {
         failures.add(new ValidationException(schema, expectedType, actualValue, "type", schema.getSchemaLocation()));
     }
 
-    void failure(ValidationException exc) {
+    @Override
+    public void failure(ValidationException exc) {
         failures.add(exc);
     }
 
-    void throwExceptionIfFailureFound() {
+    public void validationFinished() {
         ValidationException.throwFor(schema, failures);
     }
 
-    ValidationException inContextOfSchema(Schema schema, Runnable task) {
+    public ValidationException inContextOfSchema(Schema schema, Runnable task) {
         requireNonNull(schema, "schema cannot be null");
         int failureCountBefore = failures.size();
         Schema origSchema = this.schema;

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

@@ -0,0 +1,4 @@
+package org.everit.json.schema;
+
+public class EarlyFailingFailureReporter {
+}

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

@@ -8,15 +8,15 @@ class NumberSchemaValidatingVisitor extends Visitor {
 
     private final Object subject;
 
-    private final FailureReporter failureReporter;
+    private final ValidationFailureReporter failureReporter;
 
     private boolean exclusiveMinimum;
 
     private boolean exclusiveMaximum;
 
     private double numberSubject;
 
-    NumberSchemaValidatingVisitor(Object subject, FailureReporter failureReporter) {
+    NumberSchemaValidatingVisitor(Object subject, ValidationFailureReporter failureReporter) {
         this.subject = subject;
         this.failureReporter = failureReporter;
     }

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

@@ -14,9 +14,9 @@ public class StringSchemaValidatingVisitor extends Visitor {
 
     private int stringLength;
 
-    private final FailureReporter failureReporter;
+    private final ValidationFailureReporter failureReporter;
 
-    public StringSchemaValidatingVisitor(Object subject, FailureReporter failureReporter) {
+    public StringSchemaValidatingVisitor(Object subject, ValidationFailureReporter failureReporter) {
         this.subject = subject;
         this.failureReporter = requireNonNull(failureReporter, "failureReporter cannot be null");
     }

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

@@ -17,11 +17,11 @@ private static boolean isNull(Object obj) {
 
     protected Object subject;
 
-    private FailureReporter failureReporter;
+    private ValidationFailureReporter failureReporter;
 
     ValidatingVisitor(Object subject, Schema schema) {
         this.subject = subject;
-        this.failureReporter = new FailureReporter(schema);
+        this.failureReporter = new CollectingFailureReporter(schema);
     }
 
     @Override void visitNumberSchema(NumberSchema numberSchema) {
@@ -128,7 +128,7 @@ ValidationException getFailureOfSchema(Schema schema, Object input) {
     }
 
     void failIfErrorFound() {
-        failureReporter.throwExceptionIfFailureFound();
+        failureReporter.validationFinished();
     }
 
     void failure(String message, String keyword) {

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

@@ -0,0 +1,21 @@
+package org.everit.json.schema;
+
+/**
+ * Internal interface receiving validation failures. Implementations are supposed to throw or collect {@link ValidationException} instances.
+ * <p>
+ * The validation always happens in the context of some "current schema", tracked by implementations.  This {@link Schema} instance will
+ * be the {@link ValidationException#getViolatedSchema() violated schema} of the {@code ValidationException}s created.
+ * </p>
+ */
+interface ValidationFailureReporter {
+
+    void failure(String message, String keyword);
+
+    void failure(Class<?> expectedType, Object actualValue);
+
+    void failure(ValidationException exc);
+
+    ValidationException inContextOfSchema(Schema schema, Runnable task);
+
+    void validationFinished();
+}

core/src/test/java/org/everit/json/schema/FailureReporterTest.java renamed to core/src/test/java/org/everit/json/schema/CollectingFailureReporterTest.java

@@ -9,7 +9,7 @@
 import org.json.JSONObject;
 import org.junit.Test;
 
-public class FailureReporterTest {
+public class CollectingFailureReporterTest {
 
     public static final Runnable NOOP = () -> {
     };
@@ -28,7 +28,7 @@ public void subSchemaIsNull() {
 
     @Test
     public void singleExceptionAdded_andReturned() {
-        FailureReporter subject = createSubject();
+        CollectingFailureReporter subject = createSubject();
         ValidationException entry = new ValidationException(NullSchema.INSTANCE, JSONObject.NULL.getClass(), "string");
 
         ValidationException actual = subject.inContextOfSchema(NullSchema.INSTANCE, () -> {
@@ -41,7 +41,7 @@ public void singleExceptionAdded_andReturned() {
 
     @Test
     public void multipleFailures_areWrapped() {
-        FailureReporter subject = createSubject();
+        CollectingFailureReporter subject = createSubject();
         ValidationException entry1 = new ValidationException(FalseSchema.builder().build(), JSONObject.NULL.getClass(), "string");
         ValidationException entry2 = new ValidationException(NullSchema.INSTANCE, JSONObject.NULL.getClass(), "string");
 
@@ -56,7 +56,7 @@ public void multipleFailures_areWrapped() {
         assertEquals(0, subject.failureCount());
     }
 
-    private FailureReporter createSubject() {
-        return new FailureReporter(BooleanSchema.INSTANCE);
+    private CollectingFailureReporter createSubject() {
+        return new CollectingFailureReporter(BooleanSchema.INSTANCE);
     }
 }