Rename JsonNodeReader to NodeReader

Author: justin-tay

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

@@ -26,8 +26,9 @@
 import com.networknt.schema.resource.ResourceLoaders;
 import com.networknt.schema.resource.SchemaIdResolvers;
 import com.networknt.schema.resource.SchemaLoader;
-import com.networknt.schema.serialization.BasicJsonNodeReader;
-import com.networknt.schema.serialization.JsonNodeReader;
+import com.networknt.schema.serialization.BasicNodeReader;
+import com.networknt.schema.serialization.DefaultNodeReader;
+import com.networknt.schema.serialization.NodeReader;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -57,24 +58,46 @@ public class SchemaRegistry {
  public static class Builder {
  private String defaultDialectId;
  private DialectRegistry dialectRegistry = null;
- private JsonNodeReader jsonNodeReader = null;
+ private NodeReader nodeReader = null;
  private SchemaLoader schemaLoader = null;
  private boolean enableSchemaCache = true;
  private SchemaRegistryConfig schemaRegistryConfig = null;
 
  /**
  * Sets the json node reader to read the data.
  * <p>
- * If set this takes precedence over the configured json mapper and yaml mapper.
- * <p>
  * A location aware object reader can be created using
- * JsonNodeReader.builder().locationAware().build().
+ * NodeReader.builder().locationAware().build().
  *
- * @param jsonNodeReader the object reader
+ * @param nodeReader the object reader
  * @return the builder
  */
- public Builder jsonNodeReader(JsonNodeReader jsonNodeReader) {
- this.jsonNodeReader = jsonNodeReader;
+ public Builder nodeReader(NodeReader nodeReader) {
+ this.nodeReader = nodeReader;
+ return this;
+ }
+
+ /**
+ * Sets the json node reader to read the data.
+ * 
+ * <pre>
+ * A location aware object reader can be created using
+ * schemaRegistryBuilder.nodeReader(nodeReader -&gt; nodeReader.locationAware()).
+ * </pre>
+ * 
+ * A json ObjectMapper can be set using
+ * 
+ * <pre>
+ * schemaRegistryBuilder.nodeReader(nodeReader -&gt; nodeReader.jsonMapper(objectMapper))
+ * </pre>
+ * 
+ * @param customizer
+ * @return the builder
+ */
+ public Builder nodeReader(Consumer<DefaultNodeReader.Builder> customizer) {
+ DefaultNodeReader.Builder builder = NodeReader.builder();
+ customizer.accept(builder);
+ this.nodeReader = builder.build();
  return this;
  }
 
@@ -140,25 +163,25 @@ public Builder schemaRegistryConfig(SchemaRegistryConfig schemaRegistryConfig) {
  }
 
  public SchemaRegistry build() {
- return new SchemaRegistry(jsonNodeReader, defaultDialectId, schemaLoader, enableSchemaCache,
+ return new SchemaRegistry(nodeReader, defaultDialectId, schemaLoader, enableSchemaCache,
  dialectRegistry, schemaRegistryConfig);
  }
  }
 
- private final JsonNodeReader jsonNodeReader;
+ private final NodeReader nodeReader;
  private final String defaultDialectId;
  private final SchemaLoader schemaLoader;
  private final ConcurrentMap<SchemaLocation, Schema> schemaCache = new ConcurrentHashMap<>();
  private final boolean enableSchemaCache;
  private final DialectRegistry dialectRegistry;
  private final SchemaRegistryConfig schemaRegistryConfig;
 
- private SchemaRegistry(JsonNodeReader jsonNodeReader, String defaultDialectId, SchemaLoader schemaLoader,
+ private SchemaRegistry(NodeReader nodeReader, String defaultDialectId, SchemaLoader schemaLoader,
  boolean enableSchemaCache, DialectRegistry dialectRegistry, SchemaRegistryConfig schemaRegistryConfig) {
  if (defaultDialectId == null || defaultDialectId.trim().isEmpty()) {
  throw new IllegalArgumentException("defaultDialectId must not be null or empty");
  }
- this.jsonNodeReader = jsonNodeReader != null ? jsonNodeReader : BasicJsonNodeReader.getInstance();
+ this.nodeReader = nodeReader != null ? nodeReader : BasicNodeReader.getInstance();
  this.defaultDialectId = defaultDialectId;
  this.schemaLoader = schemaLoader != null ? schemaLoader : SchemaLoader.getDefault();
  this.enableSchemaCache = enableSchemaCache;
@@ -184,6 +207,10 @@ public static Builder builder() {
  /**
  * Creates a new schema registry with a default schema dialect. The schema
  * dialect will only be used if the input does not specify a $schema.
+ * <p>
+ * This uses a dialect registry that contains all the supported standard
+ * specification dialects, Draft 4, Draft 6, Draft 7, Draft 2019-09 and Draft
+ * 2020-12.
  * 
  * @param specificationVersion the default dialect id corresponding to the
  * specification version used when the schema does
@@ -197,6 +224,10 @@ public static SchemaRegistry withDefaultDialect(SpecificationVersion specificati
  /**
  * Creates a new schema registry with a default schema dialect. The schema
  * dialect will only be used if the input does not specify a $schema.
+ * <p>
+ * This uses a dialect registry that contains all the supported standard
+ * specification dialects, Draft 4, Draft 6, Draft 7, Draft 2019-09 and Draft
+ * 2020-12.
  * 
  * @param specificationVersion the default dialect id corresponding to the
  * specification version used when the schema does
@@ -213,6 +244,10 @@ public static SchemaRegistry withDefaultDialect(SpecificationVersion specificati
  /**
  * Creates a new schema registry with a default schema dialect. The schema
  * dialect will only be used if the input does not specify a $schema.
+ * <p>
+ * This uses a dialect registry that contains all the supported standard
+ * specification dialects, Draft 4, Draft 6, Draft 7, Draft 2019-09 and Draft
+ * 2020-12.
  * 
  * @param dialectId the default dialect id used when the schema does not
  * specify the $schema keyword
@@ -231,6 +266,9 @@ public static SchemaRegistry withDefaultDialectId(String dialectId, Consumer<Sch
  * Gets a new schema registry that supports a specific dialect only.
  * <p>
  * Schemas that do not specify dialect using $schema will use the dialect.
+ * <p>
+ * This uses a dialect registry that only contains this dialect and will throw
+ * an exception for unknown dialects.
  * 
  * @param dialect the dialect
  * @return the schema registry
@@ -243,6 +281,9 @@ public static SchemaRegistry withDialect(Dialect dialect) {
  * Gets a new schema registry that supports a specific dialect only.
  * <p>
  * Schemas that do not specify dialect using $schema will use the dialect.
+ * <p>
+ * This uses a dialect registry that only contains this dialect and will throw
+ * an exception for unknown dialects.
  * 
  * @param dialect the dialect
  * @param customizer to customize the registry
@@ -261,15 +302,18 @@ public static SchemaRegistry withDialect(Dialect dialect, Consumer<SchemaRegistr
  * Builder from an existing {@link SchemaRegistry}.
  * <p>
  * <code>
- * SchemaRegistry.builder(SchemaRegistry.withDefaultDialect(Specification.Version.DRAFT_2019_09));
+ * SchemaRegistry.builder(SchemaRegistry.withDefaultDialect(SpecificationVersion.DRAFT_2019_09));
  * </code>
  * 
  * @param blueprint the existing factory
  * @return the builder
  */
  public static Builder builder(SchemaRegistry blueprint) {
- Builder builder = builder().schemaLoader(blueprint.schemaLoader).defaultDialectId(blueprint.defaultDialectId)
- .jsonNodeReader(blueprint.jsonNodeReader);
+ Builder builder = builder().schemaLoader(blueprint.schemaLoader)
+ .defaultDialectId(blueprint.defaultDialectId)
+ .nodeReader(blueprint.nodeReader)
+ .dialectRegistry(blueprint.dialectRegistry)
+ .schemaRegistryConfig(blueprint.schemaRegistryConfig);
  return builder;
  }
 
@@ -402,11 +446,11 @@ public Dialect getDialect(String dialectId) {
  }
 
  JsonNode readTree(String content, InputFormat inputFormat) throws IOException {
- return this.jsonNodeReader.readTree(content, inputFormat);
+ return this.nodeReader.readTree(content, inputFormat);
  }
 
  JsonNode readTree(InputStream content, InputFormat inputFormat) throws IOException {
- return this.jsonNodeReader.readTree(content, inputFormat);
+ return this.nodeReader.readTree(content, inputFormat);
  }
 
  /**

src/main/java/com/networknt/schema/serialization/BasicJsonNodeReader.java renamed to src/main/java/com/networknt/schema/serialization/BasicNodeReader.java

@@ -24,18 +24,18 @@
 import com.networknt.schema.InputFormat;
 
 /**
- * BasicJsonNodeReader.
+ * Basic implementation of {@link NodeReader}.
  */
-public class BasicJsonNodeReader implements JsonNodeReader {
+public class BasicNodeReader implements NodeReader {
  private static class Holder {
- private static final BasicJsonNodeReader INSTANCE = new BasicJsonNodeReader();
+ private static final BasicNodeReader INSTANCE = new BasicNodeReader();
  }
 
- public static BasicJsonNodeReader getInstance() {
+ public static BasicNodeReader getInstance() {
  return Holder.INSTANCE;
  }
 
- protected BasicJsonNodeReader() {
+ protected BasicNodeReader() {
  }
 
  @Override

src/main/java/com/networknt/schema/serialization/DefaultJsonNodeReader.java renamed to src/main/java/com/networknt/schema/serialization/DefaultNodeReader.java

@@ -11,9 +11,9 @@
 import com.networknt.schema.utils.JsonNodes;
 
 /**
- * Default {@link JsonNodeReader}.
+ * Default {@link NodeReader}.
  */
-public class DefaultJsonNodeReader implements JsonNodeReader {
+public class DefaultNodeReader implements NodeReader {
  protected final ObjectMapper jsonMapper;
  protected final ObjectMapper yamlMapper;
  protected final JsonNodeFactoryFactory jsonNodeFactoryFactory;
@@ -25,7 +25,7 @@ public class DefaultJsonNodeReader implements JsonNodeReader {
  * @param yamlMapper the yaml mapper
  * @param jsonNodeFactoryFactory the json node factory factory
  */
- protected DefaultJsonNodeReader(ObjectMapper jsonMapper, ObjectMapper yamlMapper,
+ protected DefaultNodeReader(ObjectMapper jsonMapper, ObjectMapper yamlMapper,
  JsonNodeFactoryFactory jsonNodeFactoryFactory) {
  this.jsonMapper = jsonMapper;
  this.yamlMapper = yamlMapper;
@@ -84,7 +84,7 @@ protected ObjectMapper getObjectMapper(InputFormat inputFormat) {
  }
 
  /**
- * Gets the builder for {@link DefaultJsonNodeReader}.
+ * Gets the builder for {@link DefaultNodeReader}.
  * 
  * @return the builder
  */
@@ -93,7 +93,7 @@ public static Builder builder() {
  }
 
  /**
- * Builder support for {@link JsonNodeReader}.
+ * Builder support for {@link NodeReader}.
  * 
  * @param <T> the super type
  */
@@ -143,7 +143,7 @@ public T jsonNodeFactoryFactory(JsonNodeFactoryFactory jsonNodeFactoryFactory) {
  }
 
  /**
- * Builder for {@link DefaultJsonNodeReader}. 
+ * Builder for {@link DefaultNodeReader}. 
  */
  public static class Builder extends BuilderSupport<Builder> {
 
@@ -162,12 +162,12 @@ public Builder locationAware() {
  }
 
  /**
- * Builds the {@link JsonNodeReader}.
+ * Builds the {@link NodeReader}.
  *
  * @return the object reader
  */
- public JsonNodeReader build() {
- return new DefaultJsonNodeReader(this.jsonMapper, this.yamlMapper, this.jsonNodeFactoryFactory);
+ public NodeReader build() {
+ return new DefaultNodeReader(this.jsonMapper, this.yamlMapper, this.jsonNodeFactoryFactory);
  }
  }
 }

src/main/java/com/networknt/schema/serialization/JsonNodeReader.java renamed to src/main/java/com/networknt/schema/serialization/NodeReader.java

@@ -24,7 +24,7 @@
 /**
  * Reader for reading content to {@link JsonNode}.
  */
-public interface JsonNodeReader {
+public interface NodeReader {
 
  /**
  * Deserialize content as a tree.
@@ -47,11 +47,11 @@ public interface JsonNodeReader {
  JsonNode readTree(InputStream content, InputFormat inputFormat) throws IOException;
 
  /**
- * Creates a builder for {@link JsonNodeReader}.
+ * Creates a builder for {@link NodeReader}.
  *
  * @return the builder
  */
- static DefaultJsonNodeReader.Builder builder() {
- return DefaultJsonNodeReader.builder();
+ static DefaultNodeReader.Builder builder() {
+ return DefaultNodeReader.builder();
  }
 }

src/test/java/com/networknt/schema/serialization/DefaultJsonNodeReaderTest.java renamed to src/test/java/com/networknt/schema/serialization/DefaultNodeReaderTest.java

@@ -29,7 +29,7 @@
 /**
  * Test for Default Object Reader.
  */
-class DefaultJsonNodeReaderTest {
+class DefaultNodeReaderTest {
  @Test
  void location() throws JsonParseException, IOException {
  String schemaData = "{\r\n"
@@ -41,7 +41,7 @@ void location() throws JsonParseException, IOException {
  + " }\r\n"
  + " }\r\n"
  + "}";
- JsonNode jsonNode = JsonNodeReader.builder().locationAware().build().readTree(schemaData, InputFormat.JSON);
+ JsonNode jsonNode = NodeReader.builder().locationAware().build().readTree(schemaData, InputFormat.JSON);
  JsonNode idNode = jsonNode.at("/$id");
  JsonLocation location = JsonNodes.tokenLocationOf(idNode);
  assertEquals(2, location.getLineNr());
@@ -69,7 +69,7 @@ void jsonLocation() throws IOException {
  + " }\r\n"
  + " }\r\n"
  + "}";
- JsonNode jsonNode = JsonNodeReader.builder().locationAware().build().readTree(schemaData, InputFormat.JSON);
+ JsonNode jsonNode = NodeReader.builder().locationAware().build().readTree(schemaData, InputFormat.JSON);
 
  JsonLocation formatSchemaNodeTokenLocation = JsonNodes.tokenLocationOf(jsonNode.at("/properties/startDate/format"));
  JsonLocation minLengthSchemaNodeTokenLocation = JsonNodes.tokenLocationOf(jsonNode.at("/properties/startDate/minLength"));
@@ -89,7 +89,7 @@ void yamlLocation() throws IOException {
  + " startDate:\r\n"
  + " format: 'date'\r\n"
  + " minLength: 6\r\n";
- JsonNode jsonNode = JsonNodeReader.builder().locationAware().build().readTree(schemaData, InputFormat.YAML);
+ JsonNode jsonNode = NodeReader.builder().locationAware().build().readTree(schemaData, InputFormat.YAML);
 
  JsonLocation formatSchemaNodeTokenLocation = JsonNodes.tokenLocationOf(jsonNode.at("/properties/startDate/format"));
  JsonLocation minLengthSchemaNodeTokenLocation = JsonNodes.tokenLocationOf(jsonNode.at("/properties/startDate/minLength"));

src/test/java/com/networknt/schema/utils/JsonNodesTest.java

@@ -37,7 +37,7 @@
 import com.networknt.schema.SpecificationVersion;
 import com.networknt.schema.Error;
 import com.networknt.schema.serialization.JsonMapperFactory;
-import com.networknt.schema.serialization.JsonNodeReader;
+import com.networknt.schema.serialization.NodeReader;
 import com.networknt.schema.serialization.node.LocationJsonNodeFactoryFactory;
 /**
  * Tests for JsonNodes.
@@ -87,7 +87,7 @@ void jsonLocation() {
  + " \"startDate\": \"1\"\r\n"
  + "}";
  SchemaRegistry factory = SchemaRegistry.withDefaultDialect(SpecificationVersion.DRAFT_2020_12,
- builder -> builder.jsonNodeReader(JsonNodeReader.builder().locationAware().build()));
+ builder -> builder.nodeReader(nodeReader -> nodeReader.locationAware()));
  Schema schema = factory.getSchema(schemaData, InputFormat.JSON);
  List<Error> messages = schema.validate(inputData, InputFormat.JSON, executionContext -> {
  executionContext.executionConfig(executionConfig -> executionConfig.formatAssertionsEnabled(true));
@@ -132,7 +132,7 @@ void yamlLocation() {
  String inputData = "---\r\n"
  + "startDate: '1'\r\n";
  SchemaRegistry factory = SchemaRegistry.withDefaultDialect(SpecificationVersion.DRAFT_2020_12,
- builder -> builder.jsonNodeReader(JsonNodeReader.builder().locationAware().build()));
+ builder -> builder.nodeReader(NodeReader.builder().locationAware().build()));
  Schema schema = factory.getSchema(schemaData, InputFormat.YAML);
  List<Error> messages = schema.validate(inputData, InputFormat.YAML, executionContext -> {
  executionContext.executionConfig(executionConfig -> executionConfig.formatAssertionsEnabled(true));