Jsm/schema builder fluency (#3)

* update Schema.Builder to return subclassed builder

* rename ConstSchema.ConstSchemaBuilder to Builder for consistency

* add japicmp config

* add missed japicmp config

Author: JoshMcCullough

core/pom.xml

@@ -166,6 +166,30 @@
                                 <binaryCompatible>true</binaryCompatible>
                                 <sourceCompatible>true</sourceCompatible>
                             </overrideCompatibilityChangeParameter>
+                            <overrideCompatibilityChangeParameter>
+                                <compatibilityChange>METHOD_REMOVED</compatibilityChange>
+                                <binaryCompatible>true</binaryCompatible>
+                                <sourceCompatible>true</sourceCompatible>
+                                <semanticVersionLevel>MAJOR</semanticVersionLevel>
+                            </overrideCompatibilityChangeParameter>
+                            <overrideCompatibilityChangeParameter>
+                                <compatibilityChange>METHOD_RETURN_TYPE_CHANGED</compatibilityChange>
+                                <binaryCompatible>true</binaryCompatible>
+                                <sourceCompatible>true</sourceCompatible>
+                                <semanticVersionLevel>MAJOR</semanticVersionLevel>
+                            </overrideCompatibilityChangeParameter>
+                            <overrideCompatibilityChangeParameter>
+                                <compatibilityChange>CONSTRUCTOR_REMOVED</compatibilityChange>
+                                <binaryCompatible>true</binaryCompatible>
+                                <sourceCompatible>true</sourceCompatible>
+                                <semanticVersionLevel>MAJOR</semanticVersionLevel>
+                            </overrideCompatibilityChangeParameter>
+                            <overrideCompatibilityChangeParameter>
+                                <compatibilityChange>METHOD_ABSTRACT_ADDED_TO_CLASS</compatibilityChange>
+                                <binaryCompatible>true</binaryCompatible>
+                                <sourceCompatible>true</sourceCompatible>
+                                <semanticVersionLevel>MAJOR</semanticVersionLevel>
+                            </overrideCompatibilityChangeParameter>
                         </overrideCompatibilityChangeParameters>
                     </parameter>
                 </configuration>

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

@@ -19,7 +19,7 @@ public class ArraySchema
      * Builder class for {@link ArraySchema}.
      */
     public static class Builder
-            extends Schema.Builder<ArraySchema> {
+            extends Schema.Builder<ArraySchema, Builder> {
 
         private boolean requiresArray = true;
 
@@ -39,6 +39,12 @@ public static class Builder
 
         private Schema containedItemSchema;
 
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
+
         /**
          * Adds an item schema for tuple validation. The array items of the subject under validation
          * will be matched to expected schemas by their index. In other words the {n}th

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

@@ -12,7 +12,13 @@ public class BooleanSchema extends Schema {
     /**
      * Builder class for {@link BooleanSchema}.
      */
-    public static class Builder extends Schema.Builder<BooleanSchema> {
+    public static class Builder extends Schema.Builder<BooleanSchema, Builder> {
+
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
 
         @Override
         public BooleanSchema build() {

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

@@ -17,14 +17,20 @@ public class CombinedSchema extends Schema {
     /**
      * Builder class for {@link CombinedSchema}.
      */
-    public static class Builder extends Schema.Builder<CombinedSchema> {
+    public static class Builder extends Schema.Builder<CombinedSchema, Builder> {
 
         private ValidationCriterion criterion;
 
         private Collection<Schema> subschemas = new ArrayList<>();
 
         private boolean synthetic;
 
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
+
         @Override
         public CombinedSchema build() {
             return new CombinedSchema(this);

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

@@ -10,11 +10,17 @@ public class ConditionalSchema extends Schema {
     /**
      * Builder class for {@link ConditionalSchema}.
      */
-    public static class Builder extends Schema.Builder<ConditionalSchema> {
+    public static class Builder extends Schema.Builder<ConditionalSchema, Builder> {
         private Schema ifSchema;
         private Schema thenSchema;
         private Schema elseSchema;
 
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
+
         public Builder ifSchema(final Schema ifSchema) {
             this.ifSchema = ifSchema;
             return this;

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

@@ -4,27 +4,40 @@
 
 public class ConstSchema extends Schema {
 
-    public static class ConstSchemaBuilder extends Schema.Builder<ConstSchema> {
+    /**
+     * @deprecated This class has been renamed to "Builder".
+     */
+    @Deprecated
+    public static class ConstSchemaBuilder extends Builder {
+    }
+
+    public static class Builder extends Schema.Builder<ConstSchema, Builder> {
 
         private Object permittedValue;
 
-        public ConstSchemaBuilder permittedValue(Object permittedValue) {
+        public Builder permittedValue(Object permittedValue) {
             this.permittedValue = permittedValue;
             return this;
         }
 
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
+
         @Override public ConstSchema build() {
             return new ConstSchema(this);
         }
     }
 
-    public static ConstSchemaBuilder builder() {
-        return new ConstSchemaBuilder();
+    public static Builder builder() {
+        return new Builder();
     }
 
     private final Object permittedValue;
 
-    protected ConstSchema(ConstSchemaBuilder builder) {
+    protected ConstSchema(Builder builder) {
         super(builder);
         this.permittedValue = toJavaValue(builder.permittedValue);
     }

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

@@ -10,7 +10,13 @@ public class EmptySchema extends Schema {
     /**
      * Builder class for {@link EmptySchema}.
      */
-    public static class Builder extends Schema.Builder<EmptySchema> {
+    public static class Builder extends Schema.Builder<EmptySchema, Builder> {
+
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
 
         @Override
         public EmptySchema build() {

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

@@ -38,7 +38,13 @@ static List<Object> toJavaValues(List<Object> orgJsons) {
     /**
      * Builder class for {@link EnumSchema}.
      */
-    public static class Builder extends Schema.Builder<EnumSchema> {
+    public static class Builder extends Schema.Builder<EnumSchema, Builder> {
+
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
 
         private List<Object> possibleValues = new ArrayList<>();
 

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

@@ -5,7 +5,13 @@
  */
 public class FalseSchema extends Schema {
 
-    public static class Builder extends Schema.Builder<FalseSchema> {
+    public static class Builder extends Schema.Builder<FalseSchema, Builder> {
+
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
 
         @Override public FalseSchema build() {
             return new FalseSchema(this);

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

@@ -12,7 +12,13 @@ public class NotSchema extends Schema {
     /**
      * Builder class for {@link NotSchema}.
      */
-    public static class Builder extends Schema.Builder<NotSchema> {
+    public static class Builder extends Schema.Builder<NotSchema, Builder> {
+
+        @Override
+        protected Builder getBuilder()
+        {
+            return this;
+        }
 
         private Schema mustNotMatch;