Rename JsonSchemaValidator to Validator

Author: justin-tay

src/main/java/com/networknt/schema/JsonSchema.java

@@ -46,7 +46,7 @@
  * JsonSchema instances are thread-safe provided its configuration is not
  * modified.
  */
-public class JsonSchema implements JsonSchemaValidator {
+public class JsonSchema implements Validator {
     private static final long V201909_VALUE = VersionFlag.V201909.getVersionFlagValue();
     private final String id;
 

src/main/java/com/networknt/schema/JsonValidator.java

@@ -19,7 +19,7 @@
 /**
  * KeywordValidator interface implemented by all keyword validators.
  */
-public interface JsonValidator extends JsonSchemaValidator {
+public interface JsonValidator extends Validator {
     /**
      * In case the {@link com.networknt.schema.JsonValidator} has a related {@link com.networknt.schema.JsonSchema} or several
      * ones, calling preloadJsonSchema will actually load the schema document(s) eagerly.

src/main/java/com/networknt/schema/UnionTypeValidator.java

@@ -29,7 +29,7 @@
 public class UnionTypeValidator extends BaseJsonValidator implements JsonValidator {
     private static final Logger logger = LoggerFactory.getLogger(UnionTypeValidator.class);
 
-    private final List<JsonSchemaValidator> schemas;
+    private final List<Validator> schemas;
     private final String error;
 
     public UnionTypeValidator(SchemaLocation schemaLocation, JsonNodePath evaluationPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext) {
@@ -79,7 +79,7 @@ public void validate(ExecutionContext executionContext, JsonNode node, JsonNode
             List<Error> test = new ArrayList<>();
             executionContext.setFailFast(false);
             executionContext.setErrors(test);
-            for (JsonSchemaValidator schema : schemas) {
+            for (Validator schema : schemas) {
                 schema.validate(executionContext, node, rootNode, instanceLocation);
                 if (test.isEmpty()) {
                     valid = true;
@@ -105,7 +105,7 @@ public void validate(ExecutionContext executionContext, JsonNode node, JsonNode
 
     @Override
     public void preloadJsonSchema() {
-        for (final JsonSchemaValidator validator : schemas) {
+        for (final Validator validator : schemas) {
             if (validator instanceof JsonValidator) {
                 ((JsonValidator) validator).preloadJsonSchema();
             } else if (validator instanceof JsonSchema) {

…etworknt/schema/JsonSchemaValidator.java …java/com/networknt/schema/Validator.javasrc/main/java/com/networknt/schema/JsonSchemaValidator.java renamed to src/main/java/com/networknt/schema/Validator.java src/main/java/com/networknt/schema/JsonSchemaValidator.java renamed to src/main/java/com/networknt/schema/Validator.java

@@ -20,33 +20,36 @@
 import com.networknt.schema.walk.Walker;
 
 /**
- * Standard json validator interface, implemented by all validators and JsonSchema.
+ * A processor that checks an instance node belonging to an instance document
+ * against a schema.
  */
-public interface JsonSchemaValidator extends Walker {
+public interface Validator extends Walker {
     /**
-     * Validate the given JsonNode, the given node is the child node of the root node at given
-     * data path.
-     * @param executionContext  ExecutionContext
-     * @param node     JsonNode
-     * @param rootNode JsonNode
-     * @param instanceLocation JsonNodePath
+     * Validate the instance node which belongs to the instance document at the
+     * instance location.
+     * 
+     * @param executionContext the execution context
+     * @param instanceNode     the instance node being processed
+     * @param instance         the instance document that the instance node belongs
+     *                         to
+     * @param instanceLocation the location of the instance node being processed
      */
-    void validate(ExecutionContext executionContext, JsonNode node, JsonNode rootNode,
+    void validate(ExecutionContext executionContext, JsonNode instanceNode, JsonNode instance,
             JsonNodePath instanceLocation);
 
     /**
      * This is default implementation of walk method. Its job is to call the
      * validate method if shouldValidateSchema is enabled.
      */
     @Override
-    default void walk(ExecutionContext executionContext, JsonNode node, JsonNode rootNode,
+    default void walk(ExecutionContext executionContext, JsonNode instanceNode, JsonNode instance,
             JsonNodePath instanceLocation, boolean shouldValidateSchema) {
-        if (node == null) {
+        if (instanceNode == null) {
             // Note that null is not the same as NullNode
             return;
         }
         if (shouldValidateSchema) {
-            validate(executionContext, node, rootNode, instanceLocation);
+            validate(executionContext, instanceNode, instance, instanceLocation);
         }
     }
 

src/main/java/com/networknt/schema/walk/Walker.java

@@ -1,19 +1,18 @@
 package com.networknt.schema.walk;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.networknt.schema.JsonSchemaValidator;
+import com.networknt.schema.Validator;
 import com.networknt.schema.ExecutionContext;
 import com.networknt.schema.JsonNodePath;
 
 public interface Walker {
     /**
-     * 
      * This method gives the capability to walk through the given JsonNode, allowing
      * functionality beyond validation like collecting information,handling
      * cross-cutting concerns like logging or instrumentation. This method also
      * performs the validation if {@code shouldValidateSchema} is set to true. <br>
      * <br>
-     * {@link JsonSchemaValidator#walk(ExecutionContext, JsonNode, JsonNode, JsonNodePath, boolean)}
+     * {@link Validator#walk(ExecutionContext, JsonNode, JsonNode, JsonNodePath, boolean)}
      * provides a default implementation of this method. However, validators that
      * parse sub-schemas should override this method to call walk method on those
      * sub-schemas.