false)"" (none)){}
+ */
+ @Override
+ public String[] getAdditionalInterfaces() {
+ return new String[] {};
+ }
+
@Override
public String getDateTimeType() {
return null;
diff --git a/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/GenerationConfig.java b/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/GenerationConfig.java
index b05df9e4c..ef4427b02 100644
--- a/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/GenerationConfig.java
+++ b/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/GenerationConfig.java
@@ -20,6 +20,7 @@
import java.io.FileFilter;
import java.net.URL;
import java.util.Iterator;
+import java.util.List;
import org.jsonschema2pojo.rules.RuleFactory;
@@ -427,6 +428,13 @@ public interface GenerationConfig {
*/
boolean isIncludeDynamicBuilders();
+ /**
+ * Gets the `additionalInterfaces` configuration option.
+ *
+ * @return a list of interfaces added to each generated class
+ */
+ String[] getAdditionalInterfaces();
+
/**
* Gets the `dateTimeType` configuration option.
* diff --git a/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/rules/ObjectRule.java b/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/rules/ObjectRule.java index 8ec982777..af600b06a 100644 --- a/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/rules/ObjectRule.java +++ b/jsonschema2pojo-core/src/main/java/org/jsonschema2pojo/rules/ObjectRule.java @@ -122,6 +122,11 @@ public JType apply(String nodeName, JsonNode node, JsonNode parent, JPackage _pa ruleFactory.getPropertiesRule().apply(nodeName, node.get("properties"), node, jclass, schema); + if (parent == null) { + for (String _interface : ruleFactory.getGenerationConfig().getAdditionalInterfaces()) { + jclass._implements(resolveType(jclass._package(), _interface)); + } + } if (node.has("javaInterfaces")) { addInterfaces(jclass, node.get("javaInterfaces")); } diff --git a/jsonschema2pojo-core/src/test/java/org/jsonschema2pojo/rules/EnumRuleTest.java b/jsonschema2pojo-core/src/test/java/org/jsonschema2pojo/rules/EnumRuleTest.java index a038dbb74..79a8cc684 100644 --- a/jsonschema2pojo-core/src/test/java/org/jsonschema2pojo/rules/EnumRuleTest.java +++ b/jsonschema2pojo-core/src/test/java/org/jsonschema2pojo/rules/EnumRuleTest.java @@ -21,6 +21,7 @@ import static org.mockito.Mockito.*; import org.jsonschema2pojo.Annotator; +import org.jsonschema2pojo.GenerationConfig; import org.jsonschema2pojo.Schema; import org.jsonschema2pojo.util.NameHelper; import org.junit.Before; diff --git a/jsonschema2pojo-gradle-plugin/src/main/groovy/org/jsonschema2pojo/gradle/JsonSchemaExtension.groovy b/jsonschema2pojo-gradle-plugin/src/main/groovy/org/jsonschema2pojo/gradle/JsonSchemaExtension.groovy index 5f9e73b9e..9611718fe 100644 --- a/jsonschema2pojo-gradle-plugin/src/main/groovy/org/jsonschema2pojo/gradle/JsonSchemaExtension.groovy +++ b/jsonschema2pojo-gradle-plugin/src/main/groovy/org/jsonschema2pojo/gradle/JsonSchemaExtension.groovy @@ -52,6 +52,7 @@ public class JsonSchemaExtension implements GenerationConfig { boolean includeDynamicGetters boolean includeDynamicSetters boolean includeDynamicBuilders + String[] additionalInterfaces boolean includeConstructors boolean constructorsRequiredPropertiesOnly boolean includeHashcodeAndEquals @@ -139,6 +140,7 @@ public class JsonSchemaExtension implements GenerationConfig { includeDynamicGetters = false includeDynamicSetters = false includeDynamicBuilders = false + additionalInterfaces = [] as String[] formatDates = false formatTimes = false formatDateTimes = false @@ -246,6 +248,7 @@ public class JsonSchemaExtension implements GenerationConfig { |includeDynamicGetters = ${includeDynamicGetters} |includeDynamicSetters = ${includeDynamicSetters} |includeDynamicBuilders = ${includeDynamicBuilders} + |additionalInterfaces = ${additionalInterfaces} |formatDates = ${formatDates} |formatTimes = ${formatTimes} |formatDateTimes = ${formatDateTimes} diff --git a/jsonschema2pojo-integration-tests/src/test/java/org/jsonschema2pojo/integration/config/AdditionalInterfacesIT.java b/jsonschema2pojo-integration-tests/src/test/java/org/jsonschema2pojo/integration/config/AdditionalInterfacesIT.java new file mode 100644 index 000000000..5816eaa66 --- /dev/null +++ b/jsonschema2pojo-integration-tests/src/test/java/org/jsonschema2pojo/integration/config/AdditionalInterfacesIT.java @@ -0,0 +1,83 @@ +/** + * Copyright © 2010-2017 Nokia + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.jsonschema2pojo.integration.config; + +import org.jsonschema2pojo.integration.util.Jsonschema2PojoRule; +import org.junit.Rule; +import org.junit.Test; + +import java.io.Serializable; +import java.lang.reflect.Method; + +import static org.hamcrest.Matchers.arrayWithSize; +import static org.hamcrest.Matchers.emptyArray; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; +import static org.hamcrest.Matchers.typeCompatibleWith; +import static org.jsonschema2pojo.integration.util.CodeGenerationHelper.config; +import static org.junit.Assert.assertThat; + +public class AdditionalInterfacesIT { + + + @Rule public Jsonschema2PojoRule schemaRule = new Jsonschema2PojoRule(); + + @Test + public void noInterfacesAddedByDefault() throws ClassNotFoundException { + + ClassLoader resultsClassLoader = schemaRule.generateAndCompile("/schema/properties/primitiveProperties.json", "com.example"); + + Class generatedType = resultsClassLoader.loadClass("com.example.PrimitiveProperties"); + + assertThat(generatedType.getInterfaces(), is(emptyArray())); + } + + @Test + public void interfacesAddedToObject() throws ClassNotFoundException { + + ClassLoader resultsClassLoader = schemaRule.generateAndCompile("/schema/properties/primitiveProperties.json", "com.example", + config("additionalInterfaces", new String[] { Serializable.class.getName() })); + + Class generatedType = resultsClassLoader.loadClass("com.example.PrimitiveProperties"); + + assertThat(generatedType.getInterfaces(), arrayWithSize(1)); + assertThat(generatedType, typeCompatibleWith(Serializable.class)); + } + + @Test + public void interfacesNotAddedToEnum() throws ClassNotFoundException { + + ClassLoader resultsClassLoader = schemaRule.generateAndCompile("/schema/enum/enumWithEmptyString.json", "com.example", + config("additionalInterfaces", new String[] { Serializable.class.getName() })); + + Class generatedType = resultsClassLoader.loadClass("com.example.EnumWithEmptyString"); + + assertThat(generatedType.getInterfaces(), is(emptyArray())); + } + + @Test + public void interfacesAreNotAddedToObjectInSubHierarchy() throws ClassNotFoundException, NoSuchMethodException { + + ClassLoader resultsClassLoader = schemaRule.generateAndCompile("/schema/type/types.json", "com.example", + config("additionalInterfaces", new String[] { Serializable.class.getName() })); + + Class generatedType = resultsClassLoader.loadClass("com.example.Types"); + Method objectPropertyGetter = generatedType.getMethod("getObjectProperty"); + + assertThat(objectPropertyGetter.getReturnType(), not(typeCompatibleWith(Serializable.class))); + } +} diff --git a/jsonschema2pojo-maven-plugin/src/main/java/org/jsonschema2pojo/maven/Jsonschema2PojoMojo.java b/jsonschema2pojo-maven-plugin/src/main/java/org/jsonschema2pojo/maven/Jsonschema2PojoMojo.java index a1992fd2f..384348faf 100644 --- a/jsonschema2pojo-maven-plugin/src/main/java/org/jsonschema2pojo/maven/Jsonschema2PojoMojo.java +++ b/jsonschema2pojo-maven-plugin/src/main/java/org/jsonschema2pojo/maven/Jsonschema2PojoMojo.java @@ -626,6 +626,14 @@ public class Jsonschema2PojoMojo extends AbstractMojo implements GenerationConfi */ private boolean includeDynamicBuilders = false; + /** + * Interfaces to add to all generated classes. + * + * @parameter property="jsonschema2pojo.additionalInterfaces" + * default-value="" + */ + private String[] additionalInterfaces = new String[0]; + /** * The project being built. * @@ -1076,6 +1084,11 @@ public boolean isIncludeDynamicBuilders() { return includeDynamicBuilders; } + @Override + public String[] getAdditionalInterfaces() { + return additionalInterfaces; + } + @Override public String getDateTimeType() { return dateTimeType;