Add support to configure adding jackson @JsonPOJOBuilder annotations to generated builders by maff · Pull Request #232 · Randgalt/record-builder

maff · 2025-06-03T07:18:40Z

Adds a new option structure to instruct record-builder to add a Jackson @JsonPOJOBuilder annotation to the generated builder. While this implements library-specifics, it does not add Jackson as dependency (only on the test module).

Example usage:

Auto-detect Jackson version (default)

@RecordBuilder.Options(jackson = @RecordBuilder.JacksonConfig(jsonPOJOBuilder = true))

Explicitly add Jackson 2.x annotation (fail if J2 is not available):

@RecordBuilder.Options(
    jackson = @RecordBuilder.JacksonConfig(
        jsonPOJOBuilder = true,
        version = JacksonVersion.JACKSON_2
    )
)

With custom setter prefix:

@RecordBuilder.Options(
    jackson = @RecordBuilder.JacksonConfig(jsonPOJOBuilder = true),
    setterPrefix = "set"
)

Closes #229

maff · 2025-06-13T09:38:29Z

@Randgalt any feedback on this approach? I would be great to have this as an option for projects relying on Jackson and still wanting to benefit from RecordBuilder's initialization & defaults logic.

semyon-levin-workato · 2025-10-31T20:16:56Z

+            return;
+        }
+
+        final var annotationSpec = AnnotationSpec


I'm afraid it's not that simple. Recently, Jackson 3 was released with changed package names. Is it possible to check what annotations are presented on the classpath and add appropriate annotation here?

…to generated builders

Introduces a dedicated Jackson option structure. JSONPojoBuilder support can be enabled with a boolean flag. Detects available jackson version on the classpath and adds the respective annotations when enabled. Jackson version can be set to AUTO (adds annotation for every found version) or to JACKSON_2 or JACKSON_3 (only adds annotations for defined version, fails the build when library is not on the classpath).

maff · 2026-02-19T20:52:58Z

@Randgalt @semyon-levin-workato Updated to support both Jackson 2 and 3 by detecting available classes on the classpath, with support to specify a specific version in case both versions are present.

Would be awesome if we could progress with this feature for better out-of-the-box Jackson compatibility.

semyon-levin-workato · 2026-03-25T11:54:10Z

@Randgalt could you please look into this?

Randgalt · 2026-03-26T14:31:18Z

+        case AUTO -> {
+            if (!jackson2Present && !jackson3Present) {
+                processingEnv.getMessager().printMessage(ERROR,
+                        "jackson.jsonPOJOBuilder is enabled but Jackson is not found on classpath. "
+                                + "Add jackson-databind dependency or disable jsonPOJOBuilder.");
+                return;
+            }
+
+            if (jackson2Present) {
+                addJacksonAnnotations(metaData, builder, JACKSON_2_ANNOTATION_PACKAGE);
+            }
+
+            if (jackson3Present) {
+                addJacksonAnnotations(metaData, builder, JACKSON_3_ANNOTATION_PACKAGE);
+            }
+        }
+
+        case JACKSON_2 -> {
+            if (!jackson2Present) {
+                processingEnv.getMessager().printMessage(ERROR,
+                        "jackson.version is set to JACKSON_2 but Jackson 2.x is not found on classpath. "
+                                + "Add jackson-databind 2.x dependency or change version to AUTO.");
+                return;
+            }
+
+            addJacksonAnnotations(metaData, builder, JACKSON_2_ANNOTATION_PACKAGE);
+        }
+
+        case JACKSON_3 -> {
+            if (!jackson3Present) {
+                processingEnv.getMessager().printMessage(ERROR,
+                        "jackson.version is set to JACKSON_3 but Jackson 3.x is not found on classpath. "
+                                + "Add jackson-databind 3.x dependency or change version to AUTO.");
+                return;
+            }
+
+            addJacksonAnnotations(metaData, builder, JACKSON_3_ANNOTATION_PACKAGE);
+        }


Let's remove those returns

Suggested change

case AUTO -> {

if (!jackson2Present && !jackson3Present) {

processingEnv.getMessager().printMessage(ERROR,

"jackson.jsonPOJOBuilder is enabled but Jackson is not found on classpath. "

+ "Add jackson-databind dependency or disable jsonPOJOBuilder.");

return;

}

if (jackson2Present) {

addJacksonAnnotations(metaData, builder, JACKSON_2_ANNOTATION_PACKAGE);

}

if (jackson3Present) {

addJacksonAnnotations(metaData, builder, JACKSON_3_ANNOTATION_PACKAGE);

}

}

case JACKSON_2 -> {

if (!jackson2Present) {

processingEnv.getMessager().printMessage(ERROR,

"jackson.version is set to JACKSON_2 but Jackson 2.x is not found on classpath. "

+ "Add jackson-databind 2.x dependency or change version to AUTO.");

return;

}

addJacksonAnnotations(metaData, builder, JACKSON_2_ANNOTATION_PACKAGE);

}

case JACKSON_3 -> {

if (!jackson3Present) {

processingEnv.getMessager().printMessage(ERROR,

"jackson.version is set to JACKSON_3 but Jackson 3.x is not found on classpath. "

+ "Add jackson-databind 3.x dependency or change version to AUTO.");

return;

}

addJacksonAnnotations(metaData, builder, JACKSON_3_ANNOTATION_PACKAGE);

}

case AUTO -> {

if (!jackson2Present && !jackson3Present) {

processingEnv.getMessager().printMessage(ERROR,

"jackson.jsonPOJOBuilder is enabled but Jackson is not found on classpath. "

+ "Add jackson-databind dependency or disable jsonPOJOBuilder.");

}

else if (jackson2Present) {

addJacksonAnnotations(metaData, builder, JACKSON_2_ANNOTATION_PACKAGE);

}

else /*if (jackson3Present)*/ {

addJacksonAnnotations(metaData, builder, JACKSON_3_ANNOTATION_PACKAGE);

}

}

case JACKSON_2 -> {

if (!jackson2Present) {

processingEnv.getMessager().printMessage(ERROR,

"jackson.version is set to JACKSON_2 but Jackson 2.x is not found on classpath. "

+ "Add jackson-databind 2.x dependency or change version to AUTO.");

}

else {

addJacksonAnnotations(metaData, builder, JACKSON_2_ANNOTATION_PACKAGE);

}

}

case JACKSON_3 -> {

if (!jackson3Present) {

processingEnv.getMessager().printMessage(ERROR,

"jackson.version is set to JACKSON_3 but Jackson 3.x is not found on classpath. "

+ "Add jackson-databind 3.x dependency or change version to AUTO.");

} else {

addJacksonAnnotations(metaData, builder, JACKSON_3_ANNOTATION_PACKAGE);

}

}

Randgalt · 2026-03-26T14:43:24Z

-                <version>${jackson-version}</version>
+                <version>${jackson2-version}</version>
+            </dependency>
+            <dependency>


nit: add a new line here

Randgalt · 2026-03-26T14:44:12Z

Please squash the two commits

Randgalt · 2026-03-26T14:45:22Z

+     * Specifies which Jackson version(s) to use when generating builder annotations.
+     */
+    enum JacksonVersion {
+        /**


Let's add a NONE attribute here and remove @JacksonConfig. I'd also rename this RecordBuilderJacksonVersion or something to avoid name collisions with other projects (I realize some other names in here suffer from this).

Randgalt · 2026-03-26T14:45:35Z

+     */
+    @Retention(RetentionPolicy.CLASS)
+    @Target(ElementType.ANNOTATION_TYPE)
+    @interface JacksonConfig {


See comment below. We can remove this annotation.

Randgalt · 2026-03-26T14:46:08Z

+         *
+         * @see JacksonConfig
+         */
+        JacksonConfig jackson() default @JacksonConfig;


Suggested change

JacksonConfig jackson() default @JacksonConfig;

JacksonVersion jackson() default JacksonVersion.NONE;

Randgalt · 2026-03-26T14:47:05Z

+        jackson3Present = isAnnotationClassPresent(JACKSON_3_ANNOTATION_PACKAGE, JSON_POJO_BUILDER);
+    }
+
+    private boolean isAnnotationClassPresent(String packageName, String className) {


className is always JSON_POJO_BUILDER

Randgalt · 2026-03-26T14:48:20Z

+    private final boolean jackson2Present;
+    private final boolean jackson3Present;
+
+    JacksonSupport(ProcessingEnvironment processingEnv) {


Given how this is used it would be better as a utility class with a private ctor and the methods becoming static.

Randgalt · 2026-03-26T14:48:43Z

+        return processingEnv.getElementUtils().getTypeElement(packageName + "." + className) != null;
+    }
+
+    public void addJacksonAnnotations(RecordBuilder.Options metaData, TypeSpec.Builder builder) {


can be package-private

Randgalt · 2026-03-26T14:49:02Z

+        if (!anyJacksonAnnotationEnabled(metaData)) {
+            return;
+        }


This is unnecessary right?

Randgalt · 2026-03-26T14:53:42Z

+
+    private void addJsonPOJOBuilderAnnotation(RecordBuilder.Options metaData, TypeSpec.Builder builder,
+            String packageName) {
+        final var annotationSpec = AnnotationSpec.builder(ClassName.get(packageName, JSON_POJO_BUILDER))


We also need to consider metaData.builderMethodName() and metaData.withClassMethodPrefix() right? JsonPOJOBuilder has attributes for that.

Randgalt · 2026-03-26T14:54:43Z

My apologies for how long this has taken but I just haven't had a lot of time recently. I've done a first pass review. In general I'm very positive on this. Thank you.

maff mentioned this pull request Jun 3, 2025

Make RecordBuilder Jackson-friendly #229

Open

Randgalt added the I-will-review-when-I-can label Aug 10, 2025

semyon-levin-workato reviewed Oct 31, 2025

View reviewed changes

Add support to configure adding jackson @JsonPOJOBuilder annotations …

8be6b98

…to generated builders

maff force-pushed the feature-jackson-annotations branch from 83b9c46 to 227ce69 Compare February 19, 2026 20:43

maff force-pushed the feature-jackson-annotations branch from 227ce69 to 408c108 Compare February 19, 2026 20:49

Randgalt reviewed Mar 26, 2026

View reviewed changes

	JacksonConfig jackson() default @JacksonConfig;
	JacksonVersion jackson() default JacksonVersion.NONE;

Conversation

maff commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maff commented Jun 13, 2025

Uh oh!

semyon-levin-workato Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maff commented Feb 19, 2026

Uh oh!

semyon-levin-workato commented Mar 25, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Randgalt commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

maff commented Jun 3, 2025 •

edited

Loading

semyon-levin-workato Oct 31, 2025 •

edited

Loading

Randgalt commented Mar 26, 2026 •

edited

Loading