checkstyle fixes

Author: erosb

core/src/main/java/org/everit/jsonvalidator/ArraySchema.java

@@ -23,7 +23,10 @@
 import org.json.JSONArray;
 
 /**
- * Array schema.
+ * Array schema validator.
+ *
+ * {@link http://json-schema.org/latest/json-schema-validation.html#anchor36 See the according
+ * specification}.
  */
 public class ArraySchema extends Schema {
 
@@ -79,6 +82,7 @@ public Builder allItemSchema(final Schema allItemSchema) {
       return this;
     }
 
+    @Override
     public ArraySchema build() {
       return new ArraySchema(this);
     }

core/src/main/java/org/everit/jsonvalidator/BooleanSchema.java

@@ -16,12 +16,15 @@
 package org.everit.jsonvalidator;
 
 /**
- * Boolean validator.
+ * Boolean schema validator.
  */
 public class BooleanSchema extends Schema {
 
   public static final BooleanSchema INSTANCE = new BooleanSchema(builder());
 
+  /**
+   * Builder class for {@link BooleanSchema}.
+   */
   public static class Builder extends Schema.Builder {
 
     @Override

core/src/main/java/org/everit/jsonvalidator/CombinedSchema.java

@@ -21,10 +21,22 @@
 
 /**
  * Validator for {@code allOf}, {@code oneOf}, {@code anyOf} schemas.
+ *
+ * <p>
+ * See the following paragraphs of the specification for more details:
+ * <ul>
+ * <li>{@link http://json-schema.org/latest/json-schema-validation.html#anchor82}</li>
+ * <li>{@link http://json-schema.org/latest/json-schema-validation.html#anchor85}</li>
+ * <li>{@link http://json-schema.org/latest/json-schema-validation.html#anchor88}</li>
+ * </ul>
+ * </p>
  */
 public class CombinedSchema extends Schema {
 
-  public static class Builder extends Schema.Builder {
+  /**
+   * Builder class for {@link CombinedSchema}.
+   */
+  public static class Builder extends Schema.Builder<CombinedSchema> {
 
     private ValidationCriterion criterion;
 
@@ -45,6 +57,7 @@ public Builder subschemas(final Collection<Schema> subschemas) {
       return this;
     }
 
+    @Override
     public CombinedSchema build() {
       return new CombinedSchema(this);
     }
@@ -120,6 +133,9 @@ public static Builder oneOf(final Collection<Schema> schemas) {
 
   private final ValidationCriterion criterion;
 
+  /**
+   * Constructor.
+   */
   public CombinedSchema(final Builder builder) {
     super(builder);
     this.criterion = Objects.requireNonNull(builder.criterion, "criterion cannot be null");

core/src/main/java/org/everit/jsonvalidator/EmptySchema.java

@@ -44,7 +44,7 @@ public EmptySchema(final Builder builder) {
 
   @Override
   public void validate(final Object subject) {
-    // always true
+    // always passing
   }
 
 }

core/src/main/java/org/everit/jsonvalidator/EnumSchema.java

@@ -20,11 +20,17 @@
 import java.util.Set;
 
 /**
- * Enum schema.
+ * {@link Enum} schema validator.
+ *
+ * {@link http://json-schema.org/latest/json-schema-validation.html#anchor76 See the according
+ * specification}.
  */
 public class EnumSchema extends Schema {
 
-  public static class Builder extends Schema.Builder {
+  /**
+   * Builder class for {@link EnumSchema}.
+   */
+  public static class Builder extends Schema.Builder<EnumSchema> {
 
     private Set<Object> possibleValues = new HashSet<>();
 
@@ -58,7 +64,7 @@ public void validate(final Object subject) {
         .findAny()
         .orElseThrow(
         () -> new ValidationException(String.format("%s is not a valid enum value",
-            subject.toString())));
+            subject)));
   }
 
   public Set<Object> getPossibleValues() {

core/src/main/java/org/everit/jsonvalidator/NotSchema.java

@@ -18,10 +18,16 @@
 import java.util.Objects;
 
 /**
- * Not schema validator.
+ * {@code Not} schema validator.
+ *
+ * {@link http://json-schema.org/latest/json-schema-validation.html#anchor91 See the according
+ * specification}.
  */
 public class NotSchema extends Schema {
 
+  /**
+   * Builder class for {@link NotSchema}.
+   */
   public static class Builder extends Schema.Builder {
 
     private Schema mustNotMatch;
@@ -31,6 +37,7 @@ public Builder mustNotMatch(final Schema mustNotMatch) {
       return this;
     }
 
+    @Override
     public NotSchema build() {
       return new NotSchema(this);
     }

core/src/main/java/org/everit/jsonvalidator/NullSchema.java

@@ -18,13 +18,16 @@
 import org.json.JSONObject;
 
 /**
- * Null schema validator.
+ * {@code Null} schema validator.
  */
 public class NullSchema extends Schema {
 
   public static final NullSchema INSTANCE = new NullSchema(builder());
 
-  public static class Builder extends Schema.Builder {
+  /**
+   * Builder class for {@link NullSchema}.
+   */
+  public static class Builder extends Schema.Builder<NullSchema> {
 
     @Override
     public NullSchema build() {

core/src/main/java/org/everit/jsonvalidator/NumberSchema.java

@@ -18,14 +18,14 @@
 import java.math.BigDecimal;
 
 /**
- * Integer schema.
+ * Number schema validator.
  */
 public class NumberSchema extends Schema {
 
   /**
    * Builder class for {@link NumberSchema}.
    */
-  public static class Builder extends Schema.Builder {
+  public static class Builder extends Schema.Builder<NumberSchema> {
 
     private Number minimum;
 
@@ -41,6 +41,7 @@ public static class Builder extends Schema.Builder {
 
     private boolean requiresInteger = false;
 
+    @Override
     public NumberSchema build() {
       return new NumberSchema(this);
     }

core/src/main/java/org/everit/jsonvalidator/ObjectSchema.java

@@ -38,7 +38,7 @@ public class ObjectSchema extends Schema {
   /**
    * Builder class for {@link ObjectSchema}.
    */
-  public static class Builder extends Schema.Builder {
+  public static class Builder extends Schema.Builder<ObjectSchema> {
 
     private final Map<Pattern, Schema> patternProperties = new HashMap<>();
 
@@ -94,6 +94,7 @@ public Builder addRequiredProperty(final String propertyName) {
       return this;
     }
 
+    @Override
     public ObjectSchema build() {
       return new ObjectSchema(this);
     }
@@ -163,7 +164,7 @@ public static Builder builder() {
   public ObjectSchema(final Builder builder) {
     super(builder);
     this.propertySchemas = builder.propertySchemas == null ? null :
-      Collections.unmodifiableMap(builder.propertySchemas);
+        Collections.unmodifiableMap(builder.propertySchemas);
     this.additionalProperties = builder.additionalProperties;
     this.schemaOfAdditionalProperties = builder.schemaOfAdditionalProperties;
     if (!additionalProperties && schemaOfAdditionalProperties != null) {
@@ -226,12 +227,12 @@ private boolean matchesAnyPattern(final String key) {
   private void testAdditionalProperties(final JSONObject subject) {
     if (!additionalProperties) {
       getAdditionalProperties(subject)
-      .findFirst()
-      .ifPresent(unneeded -> failure("extraneous key [%s] is not permitted", unneeded));
+          .findFirst()
+          .ifPresent(unneeded -> failure("extraneous key [%s] is not permitted", unneeded));
     } else if (schemaOfAdditionalProperties != null) {
       getAdditionalProperties(subject)
-      .map(subject::get)
-      .forEach(schemaOfAdditionalProperties::validate);
+          .map(subject::get)
+          .forEach(schemaOfAdditionalProperties::validate);
     }
   }
 
@@ -255,25 +256,25 @@ private void testProperties(final JSONObject subject) {
 
   private void testPropertyDependencies(final JSONObject subject) {
     propertyDependencies.keySet().stream()
-        .filter(subject::has)
-        .flatMap(ifPresent -> propertyDependencies.get(ifPresent).stream())
-        .filter(mustBePresent -> !subject.has(mustBePresent))
-        .findFirst()
-        .ifPresent(missing -> failure("property [%s] is required", missing));
+    .filter(subject::has)
+    .flatMap(ifPresent -> propertyDependencies.get(ifPresent).stream())
+    .filter(mustBePresent -> !subject.has(mustBePresent))
+    .findFirst()
+    .ifPresent(missing -> failure("property [%s] is required", missing));
   }
 
   private void testRequiredProperties(final JSONObject subject) {
     requiredProperties.stream()
-    .filter(key -> !subject.has(key))
-    .findFirst()
-    .ifPresent(missing -> failure("required key [%s] not found", missing));
+        .filter(key -> !subject.has(key))
+        .findFirst()
+        .ifPresent(missing -> failure("required key [%s] not found", missing));
   }
 
   private void testSchemaDependencies(final JSONObject subject) {
     schemaDependencies.keySet().stream()
-        .filter(subject::has)
-        .map(schemaDependencies::get)
-        .forEach(schema -> schema.validate(subject));
+    .filter(subject::has)
+    .map(schemaDependencies::get)
+    .forEach(schema -> schema.validate(subject));
   }
 
   private void testSize(final JSONObject subject) {

core/src/main/java/org/everit/jsonvalidator/ReferenceSchema.java

@@ -15,12 +15,23 @@
  */
 package org.everit.jsonvalidator;
 
+/**
+ * This class is used by {@link org.everit.jsonvalidator.loader.SchemaLoader} to resolve references
+ * to the root schema, during the construction of the schema.
+ */
 public class ReferenceSchema extends Schema {
 
-  public static class Builder extends Schema.Builder {
+  /**
+   * Builder class for {@link ReferenceSchema}.
+   */
+  public static class Builder extends Schema.Builder<ReferenceSchema> {
 
     private ReferenceSchema retval;
 
+    /**
+     * This method caches its result, so multiple invocations will return referentially the same
+     * {@link ReferenceSchema} instance.
+     */
     @Override
     public ReferenceSchema build() {
       if (retval == null) {
@@ -53,6 +64,10 @@ public Schema getReferredSchema() {
     return referredSchema;
   }
 
+  /**
+   * Called by {@link org.everit.jsonvalidator.loader.SchemaLoader#load()} to set the referred root
+   * schema after completing the loading process of the entire schema document.
+   */
   public void setReferredSchema(final Schema referredSchema) {
     if (this.referredSchema != null) {
       throw new IllegalStateException("referredSchema can be injected only once");