Refactor format

Author: justin-tay

src/main/java/com/networknt/schema/format/AbstractRFC3986Format.java

@@ -7,7 +7,7 @@
 import com.networknt.schema.ExecutionContext;
 
 /**
- * {@link AbstractFormat} for RFC 3986.
+ * {@link Format} for RFC 3986 Uniform Resource Identifier (URI): Generic Syntax.
  */
 public abstract class AbstractRFC3986Format implements Format {
     private static final Pattern VALID = Pattern.compile("([A-Za-z0-9+-\\.]*:)?//|[A-Za-z0-9+-\\.]+:");

src/main/java/com/networknt/schema/format/Format.java

@@ -25,7 +25,6 @@
 import com.networknt.schema.NodePath;
 import com.networknt.schema.SchemaContext;
 import com.networknt.schema.TypeFactory;
-import com.networknt.schema.MessageSourceError.Builder;
 import com.networknt.schema.keyword.FormatValidator;
 
 /**
@@ -47,31 +46,17 @@ public interface Format {
      * See jsv-messages.properties.
      * <p>
      * The following are the arguments.<br>
-     * {0} The instance location<br>
-     * {1} The format name<br>
-     * {2} The error message description<br>
-     * {3} The input value
+     * {0} The format name<br>
+     * {1} The input value
+     * <p>
+     * Note that the default localized messages do not use the input value.
      * 
      * @return the message key
      */
     default String getMessageKey() {
         return "format";
     }
 
-    /**
-     * Gets the error message description.
-     * <p>
-     * Deprecated. Override getMessageKey() and set the localized message in the
-     * resource bundle or message source.
-     *
-     * @return the error message description.
-     */
-    @Deprecated
-    default String getErrorMessageDescription() {
-        return "";
-    }
-
-
     /**
      * Determines if the value matches the format.
      * <p>
@@ -154,7 +139,7 @@ default void validate(ExecutionContext executionContext, SchemaContext schemaCon
             if (!matches(executionContext, schemaContext, node, rootNode, instanceLocation, assertionsEnabled,
                     formatValidator)) {
                 executionContext.addError(message.get()
-                                .arguments(this.getName(), this.getErrorMessageDescription(), node.asText()).build());
+                                .arguments(this.getName(), node.asText()).build());
             }
         }
     }

src/main/java/com/networknt/schema/format/PatternFormat.java

@@ -27,7 +27,6 @@ public class PatternFormat implements Format {
     private final String name;
     private final Pattern pattern;
     private final String messageKey;
-    private final String errorMessageDescription;
 
     /**
      * Constructor.
@@ -36,19 +35,9 @@ public class PatternFormat implements Format {
      * 
      * @param name the name
      * @param regex the regex
-     * @param errorMessageDescription the error message description
      */
-    @Deprecated
-    public PatternFormat(String name, String regex, String errorMessageDescription) {
+    private PatternFormat(String name, String regex, String messageKey) {
         this.name = name;
-        this.errorMessageDescription = errorMessageDescription != null ? errorMessageDescription : regex;
-        this.messageKey = "format";
-        this.pattern = Pattern.compile(regex);
-    }
-    
-    private PatternFormat(String name, String regex, String errorMessageDescription, String messageKey) {
-        this.name = name;
-        this.errorMessageDescription = errorMessageDescription != null ? errorMessageDescription : regex;
         this.messageKey = messageKey;
         this.pattern = Pattern.compile(regex);
     }
@@ -62,7 +51,7 @@ private PatternFormat(String name, String regex, String errorMessageDescription,
      * @return the pattern format
      */
     public static PatternFormat of(String name, String regex, String messageKey) {
-        return new PatternFormat(name, regex, null, messageKey != null ? messageKey : "format");
+        return new PatternFormat(name, regex, messageKey != null ? messageKey : "format");
     }
 
     @Override
@@ -79,9 +68,4 @@ public String getName() {
     public String getMessageKey() {
         return this.messageKey;
     }
-
-    @Override
-    public String getErrorMessageDescription() {
-        return this.errorMessageDescription;
-    }
 }

src/main/resources/jsv-messages.properties

@@ -14,7 +14,7 @@ enum = does not have a value in the enumeration {0}
 exclusiveMaximum = must have an exclusive maximum value of {0}
 exclusiveMinimum = must have an exclusive minimum value of {0}
 false = schema for ''{0}'' is false
-format = does not match the {0} pattern {1}
+format = does not match the {0} pattern
 format.date = does not match the {0} pattern must be a valid RFC 3339 full-date
 format.date-time = does not match the {0} pattern must be a valid RFC 3339 date-time
 format.duration = does not match the {0} pattern must be a valid ISO 8601 duration

src/main/resources/jsv-messages_ar.properties

@@ -14,7 +14,7 @@ enum = \u0644\u0627 \u064A\u062D\u062A\u0648\u064A \u0639\u0644\u0649 \u0642\u06
 exclusiveMaximum = \u064A\u062C\u0628 \u0623\u0646 \u064A\u0643\u0648\u0646 \u0644\u0647 \u0642\u064A\u0645\u0629 \u0642\u0635\u0648\u0649 \u062D\u0635\u0631\u064A\u0629 \u062A\u0628\u0644\u063A {0}
 exclusiveMinimum = \u064A\u062C\u0628 \u0623\u0646 \u064A\u062D\u062A\u0648\u064A \u0639\u0644\u0649 \u0642\u064A\u0645\u0629 \u062F\u0646\u064A\u0627 \u062D\u0635\u0631\u064A\u0629 \u062A\u0628\u0644\u063A {0}
 false = \u0645\u062E\u0637\u0637 ''{0}'' \u063A\u064A\u0631 \u0635\u062D\u064A\u062D
-format = \u0644\u0627 \u064A\u0637\u0627\u0628\u0642 \u0627\u0644\u0646\u0645\u0637 {0} {1}
+format = \u0644\u0627 \u064A\u0637\u0627\u0628\u0642 \u0627\u0644\u0646\u0645\u0637 {0}
 format.date = \u0644\u0627 \u064A\u062A\u0637\u0627\u0628\u0642 \u0645\u0639 \u0627\u0644\u0646\u0645\u0637 {0} \u0648\u064A\u062C\u0628 \u0623\u0646 \u064A\u0643\u0648\u0646 \u062A\u0627\u0631\u064A\u062E\u064B\u0627 \u0643\u0627\u0645\u0644\u0627\u064B \u0635\u0627\u0644\u062D\u064B\u0627 \u0644\u0640 RFC 3339
 format.date-time = \u0644\u0627 \u064A\u062A\u0637\u0627\u0628\u0642 \u0645\u0639 \u0627\u0644\u0646\u0645\u0637 {0} \u0648\u064A\u062C\u0628 \u0623\u0646 \u064A\u0643\u0648\u0646 \u062A\u0627\u0631\u064A\u062E\u064B\u0627 \u0648\u0648\u0642\u062A\u064B\u0627 \u0635\u0627\u0644\u062D\u064B\u0627 \u0641\u064A RFC 3339
 format.duration = \u0644\u0627 \u064A\u062A\u0637\u0627\u0628\u0642 \u0645\u0639 \u0627\u0644\u0646\u0645\u0637 {0} \u0648\u064A\u062C\u0628 \u0623\u0646 \u062A\u0643\u0648\u0646 \u0645\u062F\u0629 ISO 8601 \u0635\u0627\u0644\u062D\u0629

src/main/resources/jsv-messages_cs.properties

@@ -14,7 +14,7 @@ enum = nem
 exclusiveMaximum = musí mít exkluzivní maximální hodnotu {0}
 exclusiveMinimum = musí mít exkluzivní minimální hodnotu {0}
 false = schéma pro ''{0}'' je nepravdivé
-format = neodpovídá vzoru {0} {1}
+format = neodpovídá vzoru {0}
 format.date = neodpovídá vzoru {0} musí být platné plné datum RFC 3339
 format.date-time = neodpovídá vzoru {0} musí být platné datum a \u010Das RFC 3339
 format.duration = neodpovídá vzoru {0}, musí mít platnou dobu trvání ISO 8601

src/main/resources/jsv-messages_da.properties

@@ -14,7 +14,7 @@ enum = har ikke en v
 exclusiveMaximum = skal have en eksklusiv maksimumværdi på {0}
 exclusiveMinimum = skal have en eksklusiv minimumsværdi på {0}
 false = skemaet for ''{0}'' er falsk
-format = matcher ikke {0}-mønsteret {1}
+format = matcher ikke {0}-mønsteret
 format.date = matcher ikke {0}-mønsteret skal være en gyldig RFC 3339 fuld-dato
 format.date-time = matcher ikke {0}-mønsteret skal være en gyldig RFC 3339 dato-tid
 format.duration = matcher ikke {0}-mønsteret skal være en gyldig ISO 8601-varighed

src/main/resources/jsv-messages_de.properties

@@ -14,7 +14,7 @@ enum = hat keinen Wert in der Aufz
 exclusiveMaximum = muss einen exklusiven Maximalwert von {0} haben
 exclusiveMinimum = muss einen exklusiven Mindestwert von {0} haben
 false = Schema für ''{0}'' ist falsch
-format = entspricht nicht dem Muster {0} {1}
+format = entspricht nicht dem Muster {0}
 format.date = stimmt nicht mit dem {0}-Muster überein, muss ein gültiges RFC 3339-Volldatum sein
 format.date-time = entspricht nicht dem {0}-Muster. Es muss sich um ein gültiges RFC 3339-Datum/Uhrzeit-Format handeln
 format.duration = stimmt nicht mit dem {0}-Muster überein, muss eine gültige ISO 8601-Dauer sein

src/main/resources/jsv-messages_es.properties

@@ -14,7 +14,7 @@ enum = no tiene un valor en la enumeraci\u00f3n {0}
 exclusiveMaximum = debe tener un valor m\u00e1ximo exclusivo de {0}
 exclusiveMinimum = debe tener un valor m\u00ednimo exclusivo de {0}
 false = el esquema para ''{0}'' es falso
-format = no coincide con el patr\u00f3n {0} {1}
+format = no coincide con el patr\u00f3n {0}
 format.date = no coincide con el patr\u00f3n {0}; debe ser un RFC 3339 con fecha completa v\u00e1lido
 format.date-time = no coincide con el patr\u00f3n {0}; debe ser un RFC 3339 con fecha y hora v\u00e1lido
 format.duration = no coincide con el patr\u00f3n {0}; debe ser un ISO 8601 de duraci\u00f3n v\u00e1lido

src/main/resources/jsv-messages_fa.properties

@@ -14,7 +14,7 @@ enum = \u0645\u0642\u062F\u0627\u0631\u06CC \u062F\u0631 \u0634\u0645\u0627\u063
 exclusiveMaximum = \u0628\u0627\u06CC\u062F \u062D\u062F\u0627\u06A9\u062B\u0631 \u0645\u0642\u062F\u0627\u0631 \u0627\u0646\u062D\u0635\u0627\u0631\u06CC {0} \u062F\u0627\u0634\u062A\u0647 \u0628\u0627\u0634\u062F
 exclusiveMinimum = \u0628\u0627\u06CC\u062F \u062D\u062F\u0627\u0642\u0644 \u0645\u0642\u062F\u0627\u0631 \u0627\u0646\u062D\u0635\u0627\u0631\u06CC {0} \u062F\u0627\u0634\u062A\u0647 \u0628\u0627\u0634\u062F
 false = \u0637\u0631\u062D\u0648\u0627\u0631\u0647 ''{0}'' \u0646\u0627\u062F\u0631\u0633\u062A \u0627\u0633\u062A
-format = \u0628\u0627 \u0627\u0644\u06AF\u0648\u06CC {0} {1} \u0645\u0637\u0627\u0628\u0642\u062A \u0646\u062F\u0627\u0631\u062F
+format = \u0628\u0627 \u0627\u0644\u06AF\u0648\u06CC {0} \u0645\u0637\u0627\u0628\u0642\u062A \u0646\u062F\u0627\u0631\u062F
 format.date = \u0628\u0627 \u0627\u0644\u06AF\u0648\u06CC {0} \u0645\u0637\u0627\u0628\u0642\u062A \u0646\u062F\u0627\u0631\u062F \u0628\u0627\u06CC\u062F \u062A\u0627\u0631\u06CC\u062E \u06A9\u0627\u0645\u0644 RFC 3339 \u0645\u0639\u062A\u0628\u0631 \u0628\u0627\u0634\u062F
 format.date-time = \u0628\u0627 \u0627\u0644\u06AF\u0648\u06CC {0} \u0645\u0637\u0627\u0628\u0642\u062A \u0646\u062F\u0627\u0631\u062F \u0628\u0627\u06CC\u062F \u062A\u0627\u0631\u06CC\u062E \u0648 \u0632\u0645\u0627\u0646 RFC 3339 \u0645\u0639\u062A\u0628\u0631 \u0628\u0627\u0634\u062F
 format.duration = \u0628\u0627 \u0627\u0644\u06AF\u0648\u06CC {0} \u0645\u0637\u0627\u0628\u0642\u062A \u0646\u062F\u0627\u0631\u062F \u0628\u0627\u06CC\u062F \u0645\u062F\u062A \u0632\u0645\u0627\u0646 ISO 8601 \u0645\u0639\u062A\u0628\u0631 \u0628\u0627\u0634\u062F