Updates from review

Signed-off-by: Paulo Lopes <[email protected]>

Author: pmlopes

src/main/asciidoc/index.adoc

@@ -9,7 +9,6 @@ You can use Json Schemas to validate every json structure. This module provides:
 * Implementation of https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01[draft 7]
 * Implementation of https://datatracker.ietf.org/doc/html/draft-fge-json-schema-validation-00[draft 4]
 * Dereferencing of `$ref` resolution and caching
-* Synchronous validation
 * DSL to build schemas programmatically
 
 == Using Vert.x Json Schema
@@ -50,9 +49,9 @@ underlying type.
 
 === SchemaRepository
 
-The {@link io.vertx.json.schema.SchemaRepository} is the component that holds {@link io.vertx.json.schema.JsonSchema}
-instances. It performs dereferencing of schemas to speed up validation. The repository is a simple key store, this means
-that it does not allow duplicate ids.
+The {@link io.vertx.json.schema.SchemaRepository} holds {@link io.vertx.json.schema.JsonSchema} instances. It performs
+dereferencing of schemas to speed up validation. The repository is a simple key store, this means that it does not allow
+duplicate ids.
 
 The repository can then create {@link io.vertx.json.schema.Validator} instances aware of all sub schemas in the
 repository.

src/main/java/io/vertx/json/schema/Draft.java

@@ -13,7 +13,7 @@
 import io.vertx.codegen.annotations.VertxGen;
 
 /**
- * Json-Schema draft.
+ * Json-Schema drafts.
  *
  * The enum does not explicitly define all known drafts but a selection of the most widely used ones and supported
  * in the implementation.

src/main/java/io/vertx/json/schema/JsonSchema.java

@@ -10,9 +10,11 @@
  */
 package io.vertx.json.schema;
 
+import io.vertx.codegen.annotations.Fluent;
 import io.vertx.codegen.annotations.VertxGen;
 import io.vertx.core.json.JsonObject;
 import io.vertx.json.schema.impl.BooleanSchema;
+import io.vertx.json.schema.impl.JsonObjectSchema;
 
 import java.util.Set;
 
@@ -26,7 +28,7 @@
  *   <li>Boolean based</li>
  * </ul>
  *
- * This is a common interface to handle all kids of schemas.
+ * This is a common interface to handle all kinds of schemas.
  *
  * @author Paulo Lopes
  */
@@ -39,7 +41,7 @@ public interface JsonSchema {
    * @return a wrapper for the input object.
    */
   static JsonSchema of(JsonObject json) {
-    return new io.vertx.json.schema.impl.JsonSchema(json);
+    return new JsonObjectSchema(json);
   }
 
   /**
@@ -49,7 +51,7 @@ static JsonSchema of(JsonObject json) {
    * @return a wrapper for the input object.
    */
   static JsonSchema of(String id, JsonObject json) {
-    return new io.vertx.json.schema.impl.JsonSchema(
+    return new JsonObjectSchema(
       json.copy()
         .put("id", id));
   }
@@ -72,7 +74,8 @@ static JsonSchema of(boolean bool) {
    * @param key a key
    * @param value a value
    */
-  void annotate(String key, String value);
+  @Fluent
+  JsonSchema annotate(String key, String value);
 
   /**
    * Get a type casted value by key.

src/main/java/io/vertx/json/schema/impl/BooleanSchema.java

@@ -16,7 +16,7 @@ private BooleanSchema(boolean bool) {
   }
 
   @Override
-  public void annotate(String key, String value) {
+  public JsonSchema annotate(String key, String value) {
     throw new UnsupportedOperationException("This schema doesn't support annotate(String, String)");
   }
 

…o/vertx/json/schema/impl/JsonSchema.java …x/json/schema/impl/JsonObjectSchema.javasrc/main/java/io/vertx/json/schema/impl/JsonSchema.java renamed to src/main/java/io/vertx/json/schema/impl/JsonObjectSchema.java src/main/java/io/vertx/json/schema/impl/JsonSchema.java renamed to src/main/java/io/vertx/json/schema/impl/JsonObjectSchema.java

@@ -1,20 +1,21 @@
 package io.vertx.json.schema.impl;
 
 import io.vertx.core.json.JsonObject;
+import io.vertx.json.schema.JsonSchema;
 
 import java.util.HashSet;
 import java.util.Set;
 
-public final class JsonSchema extends JsonObject implements io.vertx.json.schema.JsonSchema {
+public final class JsonObjectSchema extends JsonObject implements JsonSchema {
 
   private boolean annotated;
 
-  public JsonSchema(JsonObject json) {
+  public JsonObjectSchema(JsonObject json) {
     super(json.getMap());
   }
 
   @Override
-  public void annotate(String key, String value) {
+  public JsonSchema annotate(String key, String value) {
     switch (key) {
       case "__absolute_uri__":
         annotated = true;
@@ -31,6 +32,7 @@ public void annotate(String key, String value) {
       default:
         throw new IllegalArgumentException("Unsupported annotation: " + key);
     }
+    return this;
   }
 
   @Override

src/main/java/io/vertx/json/schema/impl/SchemaRepositoryImpl.java

@@ -110,7 +110,7 @@ public Validator validator(io.vertx.json.schema.JsonSchema schema, JsonSchemaOpt
   }
 
   static void dereference(Map<String, io.vertx.json.schema.JsonSchema> lookup, io.vertx.json.schema.JsonSchema schema, URL baseURI, String basePointer, boolean schemaRoot) {
-    if (schema instanceof JsonSchema) {
+    if (schema instanceof JsonObjectSchema) {
       // This addresses the Unknown Keyword requirements, non sub-schema's with $id are to ignore the
       // given $id as it could collide with existing resolved schemas
       final String id = schemaRoot ? schema.get("$id", schema.get("id")) : null;

src/main/java/io/vertx/json/schema/impl/Utils.java

@@ -349,7 +349,7 @@ public static JsonSchema wrap(JsonObject object, String key) {
       }
 
       if (value instanceof JsonObject) {
-        JsonSchema schema = new io.vertx.json.schema.impl.JsonSchema((JsonObject) value);
+        JsonSchema schema = new JsonObjectSchema((JsonObject) value);
         object.put(key, schema);
         return schema;
       }
@@ -376,7 +376,7 @@ public static JsonSchema wrap(JsonArray array, int index) {
       }
 
       if (value instanceof JsonObject) {
-        JsonSchema schema = new io.vertx.json.schema.impl.JsonSchema((JsonObject) value);
+        JsonSchema schema = new JsonObjectSchema((JsonObject) value);
         array.set(index, schema);
         return schema;
       }