extracted WrappingFormatValidator, deprecated SchemaLoaderBuilder#addFormatValidator(String, FormatValidator), and added javadoc

Author: erosb

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

@@ -80,6 +80,17 @@ static FormatValidator forFormat(final String formatName) {
      */
     Optional<String> validate(String subject);
 
+    /**
+     * Provides the name of this format.
+     *
+     * Unless specified otherwise the {@link org.everit.json.schema.loader.SchemaLoader} will use this
+     * name to recognize string schemas using this format.
+     *
+     * The default implementation of this method returns {@code "unnamed-format"}. It is strongly
+     * recommended for implementations to give a more meaningful name by overriding this method.
+     *
+     * @return the format name.
+     */
     default String formatName() {
         return "unnamed-format";
     }

core/src/main/java/org/everit/json/schema/loader/SchemaLoader.java

@@ -18,11 +18,8 @@
 import org.everit.json.schema.*;
 import org.everit.json.schema.ObjectSchema.Builder;
 import org.everit.json.schema.internal.*;
-import org.everit.json.schema.loader.internal.DefaultSchemaClient;
-import org.everit.json.schema.loader.internal.JSONPointer;
+import org.everit.json.schema.loader.internal.*;
 import org.everit.json.schema.loader.internal.JSONPointer.QueryResult;
-import org.everit.json.schema.loader.internal.ReferenceResolver;
-import org.everit.json.schema.loader.internal.TypeBasedMultiplexer;
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -75,21 +72,34 @@ public static class SchemaLoaderBuilder {
             formatValidators.put("hostname", new HostnameFormatValidator());
         }
 
+        /**
+         * Registers a format validator with the name returned by {@link FormatValidator#formatName()}.
+         *
+         * @param formatValidator
+         * @return {@code this}
+         */
+        public SchemaLoaderBuilder addFormatValidator(FormatValidator formatValidator) {
+            formatValidators.put(formatValidator.formatName(), formatValidator);
+            return this;
+        }
+
+        /**
+         * @param formatName
+         *      the name which will be used in the schema JSON files to refer to this {@code formatValidator}
+         * @param formatValidator
+         *      the object performing the validation for schemas which use the {@code formatName} format
+         * @return {@code this}
+         * @deprecated instead it is better to override {@link FormatValidator#formatName()}
+         *      and use {@link #addFormatValidator(FormatValidator)}
+         */
+        @Deprecated
         public SchemaLoaderBuilder addFormatValidator(final String formatName,
                 final FormatValidator formatValidator) {
-            FormatValidator wrappingFormatValidator = new FormatValidator() {
-
-                @Override
-                public Optional<String> validate(String subject) {
-                    return formatValidator.validate(subject);
-                }
-
-                @Override
-                public String formatName() {
-                    return formatName;
-                }
-            };
-            formatValidators.put(formatName, wrappingFormatValidator);
+            if (!Objects.equals(formatName, formatValidator.formatName())) {
+                formatValidators.put(formatName, new WrappingFormatValidator(formatName, formatValidator));
+            } else {
+                formatValidators.put(formatName, formatValidator);
+            }
             return this;
         }
 

core/src/main/java/org/everit/json/schema/loader/internal/WrappingFormatValidator.java

@@ -0,0 +1,29 @@
+package org.everit.json.schema.loader.internal;
+
+import org.everit.json.schema.FormatValidator;
+
+import java.util.Optional;
+import static java.util.Objects.requireNonNull;
+
+public class WrappingFormatValidator implements FormatValidator {
+
+    private final String formatName;
+    private final FormatValidator formatValidator;
+
+    public WrappingFormatValidator(String formatName, FormatValidator wrappedValidator) {
+        this.formatName = requireNonNull(formatName, "formatName cannot be null");
+        this.formatValidator = requireNonNull(wrappedValidator, "wrappedValidator cannot be null");
+    }
+
+
+
+    @Override
+    public Optional<String> validate(String subject) {
+        return formatValidator.validate(subject);
+    }
+
+    @Override
+    public String formatName() {
+        return formatName;
+    }
+}

core/src/test/java/org/everit/json/schema/loader/CustomFormatValidatorTest.java

@@ -75,4 +75,15 @@ public void nameOverride() {
         assertEquals("somethingelse", actual);
     }
 
+    @Test
+    public void formatValidatorWithoutExplicitName() {
+        SchemaLoader schemaLoader = SchemaLoader.builder()
+                .schemaJson(loader.readObj("customformat-schema.json"))
+                .addFormatValidator(new EvenCharNumValidator())
+                .build();
+        Object actual = new JSONObject(schemaLoader.load().build().toString())
+                .query("/properties/id/format");
+        assertEquals("evenlength", actual);
+    }
+
 }