feat: Rename JacksonModule to JacksonSchemaModule to avoid clashing with the JacksonModule from jackson-databind (#561)

Author: filiphr

jsonschema-examples/src/main/java/com/github/victools/jsonschema/examples/JacksonDescriptionAsTitleExample.java

@@ -26,7 +26,7 @@
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaVersion;
 import com.github.victools.jsonschema.generator.TypeScope;
-import com.github.victools.jsonschema.module.jackson.JacksonModule;
+import com.github.victools.jsonschema.module.jackson.JacksonSchemaModule;
 import java.util.UUID;
 import tools.jackson.databind.node.ObjectNode;
 
@@ -59,9 +59,9 @@ public UUID getId() {
     }
 
     /**
-     * Override of the standard JacksonModule, that assigns all description values to the title keyword instead.
+     * Override of the standard JacksonSchemaModule, that assigns all description values to the title keyword instead.
      */
-    static class JacksonTitleModule extends JacksonModule {
+    static class JacksonTitleModule extends JacksonSchemaModule {
         @Override
         public void applyToConfigBuilder(SchemaGeneratorConfigBuilder builder) {
             super.applyToConfigBuilder(builder);

jsonschema-examples/src/main/java/com/github/victools/jsonschema/examples/JacksonSubtypeDefinitionExample.java

@@ -24,8 +24,8 @@
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfig;
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaVersion;
-import com.github.victools.jsonschema.module.jackson.JacksonModule;
 import com.github.victools.jsonschema.module.jackson.JacksonOption;
+import com.github.victools.jsonschema.module.jackson.JacksonSchemaModule;
 import java.util.List;
 import tools.jackson.databind.node.ObjectNode;
 
@@ -38,7 +38,7 @@ public class JacksonSubtypeDefinitionExample implements SchemaGenerationExampleI
 
     @Override
     public ObjectNode generateSchema() {
-        JacksonModule jacksonModule = new JacksonModule(JacksonOption.ALWAYS_REF_SUBTYPES, JacksonOption.INLINE_TRANSFORMED_SUBTYPES);
+        JacksonSchemaModule jacksonModule = new JacksonSchemaModule(JacksonOption.ALWAYS_REF_SUBTYPES, JacksonOption.INLINE_TRANSFORMED_SUBTYPES);
         SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2020_12, OptionPreset.PLAIN_JSON)
                 .with(jacksonModule)
                 .with(Option.DEFINITIONS_FOR_ALL_OBJECTS, Option.DEFINITIONS_FOR_MEMBER_SUPERTYPES, Option.DEFINITION_FOR_MAIN_SCHEMA);

jsonschema-examples/src/main/java/com/github/victools/jsonschema/examples/OpenAiFunctionCallingSchemaExample.java

@@ -30,8 +30,8 @@
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaKeyword;
 import com.github.victools.jsonschema.generator.SchemaVersion;
-import com.github.victools.jsonschema.module.jackson.JacksonModule;
 import com.github.victools.jsonschema.module.jackson.JacksonOption;
+import com.github.victools.jsonschema.module.jackson.JacksonSchemaModule;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.util.Iterator;
@@ -50,7 +50,7 @@ public class OpenAiFunctionCallingSchemaExample implements SchemaGenerationExamp
     public ObjectNode generateSchema() {
         SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2020_12, OptionPreset.PLAIN_JSON);
         configBuilder.with(Option.INLINE_ALL_SCHEMAS);
-        configBuilder.with(new JacksonModule(JacksonOption.RESPECT_JSONPROPERTY_REQUIRED));
+        configBuilder.with(new JacksonSchemaModule(JacksonOption.RESPECT_JSONPROPERTY_REQUIRED));
         configBuilder.forFields().withCustomDefinitionProvider(this);
         SchemaGeneratorConfig config = configBuilder.build();
         SchemaGenerator generator = new SchemaGenerator(config);

jsonschema-maven-plugin/src/main/java/com/github/victools/jsonschema/plugin/maven/SchemaGeneratorMojo.java

@@ -23,8 +23,8 @@
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaVersion;
 import com.github.victools.jsonschema.generator.impl.Util;
-import com.github.victools.jsonschema.module.jackson.JacksonModule;
 import com.github.victools.jsonschema.module.jackson.JacksonOption;
+import com.github.victools.jsonschema.module.jackson.JacksonSchemaModule;
 import com.github.victools.jsonschema.module.jakarta.validation.JakartaValidationModule;
 import com.github.victools.jsonschema.module.jakarta.validation.JakartaValidationOption;
 import com.github.victools.jsonschema.module.javax.validation.JavaxValidationModule;
@@ -504,7 +504,7 @@ private void addStandardModule(GeneratorModule module, SchemaGeneratorConfigBuil
         switch (module.name) {
         case "Jackson":
             this.getLog().debug("- Adding Jackson Module");
-            this.addStandardModuleWithOptions(module, configBuilder, JacksonModule::new, JacksonOption.class);
+            this.addStandardModuleWithOptions(module, configBuilder, JacksonSchemaModule::new, JacksonOption.class);
             break;
         case "JakartaValidation":
             this.getLog().debug("- Adding Jakarta Validation Module");

jsonschema-maven-plugin/src/test/java/com/github/victools/jsonschema/plugin/maven/SchemaGeneratorMojoTest.java

@@ -52,7 +52,7 @@ public void setUp() throws Exception {
     @ValueSource(strings = {
         "DefaultConfig",
         "SchemaVersion",
-        "JacksonModule",
+        "JacksonSchemaModule",
         "JavaxValidationModule",
         "JakartaValidationModule",
         "Swagger15Module",

…ference-test-cases/JacksonModule-pom.xml …e-test-cases/JacksonSchemaModule-pom.xmljsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonModule-pom.xml renamed to jsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonSchemaModule-pom.xml jsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonModule-pom.xml renamed to jsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonSchemaModule-pom.xml

@@ -6,7 +6,7 @@
                 <artifactId>jsonschema-maven-plugin</artifactId>
                 <configuration>
                     <classNames>com.github.victools.jsonschema.plugin.maven.TestClass</classNames>
-                    <schemaFilePath>target/generated-test-sources/JacksonModule</schemaFilePath>
+                    <schemaFilePath>target/generated-test-sources/JacksonSchemaModule</schemaFilePath>
                     <modules>
                         <module>
                             <name>Jackson</name>

…-test-cases/JacksonModule-reference.json …cases/JacksonSchemaModule-reference.jsonjsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonModule-reference.json renamed to jsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonSchemaModule-reference.json jsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonModule-reference.json renamed to jsonschema-maven-plugin/src/test/resources/reference-test-cases/JacksonSchemaModule-reference.json

@@ -52,10 +52,10 @@ It is recommended to use identical versions for both dependencies to ensure comp
 ```java
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaVersion;
-import com.github.victools.jsonschema.module.jackson.JacksonModule;
+import com.github.victools.jsonschema.module.jackson.JacksonSchemaModule;
 ```
 ```java
-JacksonModule module = new JacksonModule();
+JacksonSchemaModule module = new JacksonSchemaModule();
 SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2019_09)
     .with(module);
 ```
@@ -67,11 +67,11 @@ import com.github.victools.jsonschema.generator.SchemaGenerator;
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfig;
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaVersion;
-import com.github.victools.jsonschema.module.jackson.JacksonModule;
+import com.github.victools.jsonschema.module.jackson.JacksonSchemaModule;
 import tools.jackson.databind.JsonNode;
 ```
 ```java
-JacksonModule module = new JacksonModule();
+JacksonSchemaModule module = new JacksonSchemaModule();
 SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2019_09, OptionPreset.PLAIN_JSON)
     .with(module);
 SchemaGeneratorConfig config = configBuilder.build();

jsonschema-module-jackson/README.md

@@ -122,7 +122,7 @@ protected ResolvedMethod getJsonValueAnnotatedMethod(ResolvedType javaType, Sche
         ResolvedMethod[] memberMethods = context.getTypeContext().resolveWithMembers(javaType).getMemberMethods();
         Set<ResolvedMethod> jsonValueAnnotatedMethods = Stream.of(memberMethods)
                 .filter(method -> method.getArgumentCount() == 0)
-                .filter(method -> AnnotationHelper.resolveAnnotation(method, JsonValue.class, JacksonModule.NESTED_ANNOTATION_CHECK)
+                .filter(method -> AnnotationHelper.resolveAnnotation(method, JsonValue.class, JacksonSchemaModule.NESTED_ANNOTATION_CHECK)
                         .map(JsonValue::value)
                         .orElse(false))
                 .collect(Collectors.toSet());
@@ -145,7 +145,7 @@ protected List<String> getSerializedValuesFromJsonProperty(ResolvedType javaType
             for (Object enumConstant : enumConstants) {
                 String enumValueName = ((Enum<?>) enumConstant).name();
                 Optional<JsonProperty> annotation = AnnotationHelper.resolveAnnotation(javaType.getErasedType().getDeclaredField(enumValueName),
-                        JsonProperty.class, JacksonModule.NESTED_ANNOTATION_CHECK);
+                        JsonProperty.class, JacksonSchemaModule.NESTED_ANNOTATION_CHECK);
                 if (!annotation.isPresent()) {
                     // enum constant without @JsonProperty annotation
                     return null;