feeding our precious checkstyle rules

Author: erosb

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

@@ -17,6 +17,9 @@
 
 import java.util.Arrays;
 
+/**
+ * Represents a JSON Schema keyword applicable as a "format" value.
+ */
 public enum Format {
 
   DATE_TIME {
@@ -68,6 +71,10 @@ public String toString() {
 
   };
 
+  /**
+   * Looks up a format instance by its name used in the json schema spec (like "date-time",
+   * "hostname", "ipv6" etc).
+   */
   public static Format forName(final String name) {
     return Arrays.stream(Format.values())
         .filter(fmt -> fmt.toString().equals(name))

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

@@ -19,15 +19,19 @@
 
 import org.everit.json.schema.internal.DefaultFormatValidator;
 
+/**
+ * Implementations perform the validation against the "format" keyword (see JSON Schema spec section
+ * 7).
+ */
 @FunctionalInterface
 public interface FormatValidator {
 
   /**
-   * No-operation implementation (never throws {@link ValidationException}).
+   * No-operation implementation (never throws {always returns {@link Optional#empty()}).
    */
-  public static final FormatValidator NONE = (subject, format) -> Optional.empty();
+  FormatValidator NONE = (subject, format) -> Optional.empty();
 
-  public static FormatValidator DEFAULT = new DefaultFormatValidator();
+  FormatValidator DEFAULT = new DefaultFormatValidator();
 
   Optional<String> validate(String subject, Format format);
 

core/src/main/java/org/everit/json/schema/internal/DefaultFormatValidator.java

@@ -30,6 +30,9 @@
 import com.google.common.net.InetAddresses;
 import com.google.common.net.InternetDomainName;
 
+/**
+ * Default implementation of {@link FormatValidator}.
+ */
 public class DefaultFormatValidator implements FormatValidator {
 
   private static final int IPV4_LENGTH = 4;
@@ -86,7 +89,7 @@ private Optional<String> checkIpAddress(final String subject, final int expected
       final String failureFormat) {
     return asInetAddress(subject)
         .filter(addr -> addr.getAddress().length == expectedLength)
-        .map(addr -> Optional.<String> empty())
+        .map(addr -> emptyString())
         .orElse(Optional.of(String.format(failureFormat, subject)));
   }
 
@@ -99,6 +102,10 @@ private Optional<String> checkURI(final String subject) {
     }
   }
 
+  private Optional<String> emptyString() {
+    return Optional.empty();
+  }
+
   @Override
   public Optional<String> validate(final String subject, final Format format) {
     Objects.requireNonNull(format, "format cannot be null");