formatting & javadoc in CombinedSchema, ObjectSchema, Schema

Author: erosb

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

@@ -180,10 +180,10 @@ public void validate(final Object subject) {
   }
 
   @Override
-  public boolean definesProperty(String field) {
+  public boolean definesProperty(final String field) {
     List<Schema> matching = subschemas.stream()
-            .filter(schema -> schema.definesProperty(field))
-            .collect(Collectors.toList());
+        .filter(schema -> schema.definesProperty(field))
+        .collect(Collectors.toList());
     try {
       criterion.validate(subschemas.size(), matching.size());
     } catch (ValidationException e) {

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

@@ -15,10 +15,6 @@
  */
 package org.everit.json.schema;
 
-import com.google.common.base.Splitter;
-import com.google.common.collect.Lists;
-import org.json.JSONObject;
-
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -34,6 +30,11 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.json.JSONObject;
+
+import com.google.common.base.Splitter;
+import com.google.common.collect.Lists;
+
 /**
  * Object schema validator.
  */
@@ -398,11 +399,11 @@ public void validate(final Object subject) {
   public boolean definesProperty(String field) {
     field = field.replaceFirst("^#", "").replaceFirst("^/", "");
     return !field.isEmpty() && (definesPatternProperty(field)
-            || definesSchemaDependencyProperty(field)
-            || definesSchemaProperty(field));
+        || definesSchemaDependencyProperty(field)
+        || definesSchemaProperty(field));
   }
 
-  private boolean definesSchemaProperty(String field) {
+  private boolean definesSchemaProperty(final String field) {
     List<String> fields = Lists.newArrayList(Splitter.on("/").limit(2).split(field));
     String current = unescape(fields.get(0));
     boolean hasSuffix = fields.size() > 1;
@@ -417,18 +418,23 @@ private boolean definesSchemaProperty(String field) {
     return false;
   }
 
-  private boolean definesPatternProperty(String field) {
-    return patternProperties.keySet().stream().filter(pattern -> pattern.matcher(field).matches())
-            .findAny().isPresent();
+  private boolean definesPatternProperty(final String field) {
+    return patternProperties.keySet()
+        .stream()
+        .filter(pattern -> pattern.matcher(field).matches())
+        .findAny()
+        .isPresent();
   }
 
-  private boolean definesSchemaDependencyProperty(String field) {
+  private boolean definesSchemaDependencyProperty(final String field) {
     return schemaDependencies.containsKey(field)
-            || schemaDependencies.values().stream().filter(schema -> schema.definesProperty(field))
-            .findAny().isPresent();
+        || schemaDependencies.values().stream()
+            .filter(schema -> schema.definesProperty(field))
+            .findAny()
+            .isPresent();
   }
 
-  private String unescape(String value) {
+  private String unescape(final String value) {
     return value.replace("~1", "/").replace("~0", "~");
   }
 

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

@@ -85,6 +85,49 @@ protected Schema(final Builder<?> builder) {
    */
   public abstract void validate(final Object subject);
 
+  /**
+   * Determines if this {@code Schema} instance defines any restrictions for the object property
+   * denoted by {@code field}. The {@code field} should be a JSON pointer, denoting the property to
+   * be queried.
+   *
+   * For example the field {@code "#/rectangle/a"} is defined by the following schema:
+   *
+   * <pre>
+   * <code>
+   * objectWithSchemaRectangleDep" : {
+   *   "type" : "object",
+   *   "dependencies" : {
+   *       "d" : {
+   *           "type" : "object",
+   *           "properties" : {
+   *               "rectangle" : {"$ref" : "#/definitions/Rectangle" }
+   *           }
+   *       }
+   *   },
+   *   "definitions" : {
+   *       "size" : {
+   *           "type" : "number",
+   *           "minimum" : 0
+   *       },
+   *       "Rectangle" : {
+   *           "type" : "object",
+   *           "properties" : {
+   *               "a" : {"$ref" : "#/definitions/size"},
+   *               "b" : {"$ref" : "#/definitions/size"}
+   *           }
+   *       }
+   *    }
+   * }
+   * </code>
+   * </pre>
+   *
+   * The default implementation of this method always returns false.
+   *
+   * @param field
+   *          should be a JSON pointer in its string representation.
+   * @return {@code true} if the propertty denoted by {@code field} is defined by this schema
+   *         instance
+   */
   public boolean definesProperty(final String field) {
     return false;
   }