Propagate deprecation metadata from DTO source elements into generated builders (#235) - #253
Merged
AndreasIgel merged 17 commits intoAug 16, 2026
Merged
Conversation
The class-level Javadoc and docs/CONFIGURATION.md implied that @SimpleBuilder is inherited by subclasses, but the annotation was not meta-annotated with @inherited. As a result BuilderProcessor, which collects types via RoundEnvironment.getElementsAnnotatedWith(...), only produced builders for the exact type carrying @SimpleBuilder and not for unannotated subclasses. Add @inherited to @SimpleBuilder so subclasses are treated as if they also carried the annotation, mirroring the existing behaviour of @SimpleBuilder.Template (which is already @inherited). Update the Javadoc to document the inheritance explicitly and clarify the CONFIGURATION.md wording. @Ignore4BuilderGeneration still suppresses generation for the exact type it is placed on, so opt-outs continue to work as before. Add SimpleBuilderInheritanceTest covering direct inheritance, the opt-out interaction, and multi-level (grandchild) inheritance. Closes #244 Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…ance Rename SimpleBuilderInheritanceTest to BuilderAnnotationInheritanceTest so the name reflects that it covers both builder-triggering annotations. Add unannotatedSubclassGetsBuilderFromInheritedTemplate, which verifies that a custom @inherited template annotation (meta-annotated with @SimpleBuilder.Template) propagates to unannotated subclasses, matching the existing behaviour of @SimpleBuilder itself. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
The Template Javadoc and CONFIGURATION.md "Template Annotations" section did not explain that @SimpleBuilder.Template is @inherited, nor that a custom template annotation must additionally declare @inherited to propagate to unannotated subclasses. Add explicit documentation and an example showing the @inherited custom annotation pattern. Also move assertNoBuilderGenerated to ProcessorAsserts so it is shared by BuilderAnnotationInheritanceTest and Ignore4BuilderGenerationTest instead of being duplicated as a private helper in each test class. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
While @SimpleBuilder and @inherited template annotations now correctly trigger builder generation for unannotated subclasses, the configuration options declared on the parent's @SimpleBuilder(options = ...) or template are not yet applied to inherited subclass builders — they use default options instead. This is tracked separately in issue #245. Add caveats to the SimpleBuilder Javadoc, the CONFIGURATION.md Template Annotations section, and the Template Annotations Not Working troubleshooting section so users are not surprised by this limitation. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…nto Builder Implementation of first
… checking field-deprecation in dtos
…s annotation is added for these cases too
AndreasIgel
force-pushed
the
feature/issue-235-deprecated-annotation-propagation
branch
from
August 16, 2026 18:21
d1d0f12 to
47423e0
Compare
…ation Resolved Javadoc conflict in SimpleBuilder.Template by taking the more complete documentation from main (ANNOTATION_TYPE restriction note and issue #248 reference). Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
…ation Resolved conflict in SimpleBuilder.java: took updated Javadoc from origin/main (PR #252) which now documents that template options ARE applied to inherited subclass builders, replacing the old note about issue #248. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
AndreasIgel
deleted the
feature/issue-235-deprecated-annotation-propagation
branch
August 16, 2026 20:45
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
Resolves #235
Problem
Generated builders did not carry
@Deprecatedannotations or@deprecatedJavadoc from the source DTO elements. Consumers of the generated builder APIs had no indication that a property or DTO class was deprecated, and the generated implementation code produced unchecked deprecation warnings when internally calling deprecated DTO members.Solution
This PR propagates deprecation metadata through the full DTO-to-builder generation pipeline:
Deprecation propagation to generated builder methods:
@Deprecatedon constructor parameters, record components, setter methods, and field types is detected and propagated to all generated builder methods for that property (fluent setter, supplier, consumer, varargs, string-format, collection helpers,Withinterface).sinceandforRemovalattributes are preserved.@deprecatedJavadoc text is extracted from the enclosing executable (setter/constructor) or record component and added to the generated method Javadoc.Deprecation propagation from DTO class:
@Deprecatedon the DTO class propagates to the generated builder class itself, both constructors, and thecreate()factory method.Class-level suppression:
@SuppressWarnings({"deprecation", "removal"})when any internal call touches a deprecated member:create()internallyDesign decisions:
GetterInfoDtoduring field creation and checked separately.anyMethodDeprecatedcheck since it propagates@Deprecatedto builder methods.@Deprecatedis not copied to builder method parameters — the parameter is a new declaration; deprecation is about the property, not the parameter value. The annotation is applied to the builder method itself viaDeprecationInfoDto.Changes
Implementation:
DeprecationInfoDto— new DTO carrying the@Deprecatedannotation (withsince/forRemoval) and@deprecatedJavadoc text.GetterInfoDto— new record consolidating getter name and deprecation flag, set during field creation. Enforces non-null getter name via compact constructor.FieldDto— nullabledeprecationInfofield;isDeprecated()derives fromdeprecatedAnnotation != null.getterInfofield replaces separategetterName/getterDeprecatedfields; convenience methodsgetGetterName()andisGetterDeprecated()delegate to it.FieldAnnotationExtractor—extractDeprecatedAnnotation(Element, ProcessingContext)detects@Deprecatedon any element without applying annotation filters.@Deprecatedadded toANNOTATION_FILTERSso it is no longer copied to builder parameters. SplitextractAnnotationinto filtering and non-filtering variants.BuilderDefinitionCreator—detectAndApplyFieldDeprecation(...)detects deprecation from parameter -> record component -> setter -> field type (getter and backing field excluded).applyDeprecationToMethod(...)applies@Deprecatedand Javadoc to generated methods.applyDeprecationSuppressions(...)adds class-level@SuppressWarningsbased on internal deprecated calls, usingDEPRECATED_TYPE = map2TypeName(Deprecated.class)for type-safeTypeNamecomparison.JavaLangAnalyser— added findFieldElement(...) (using ElementFilter.fieldsIn(...)), findRecordComponent(...), and extractDeprecatedJavaDoc(...) helpers.RoasterCodeGenerator— renders@Deprecatedand@SuppressWarningsviaapplyAnnotationswith simple-name handling forjava.langannotations.JavadocDto— addedaddDeprecated(String)for@deprecatedtag support.Tests:
AnnotationCopyTest— 22 tests covering: deprecated constructor parameter, deprecated setter, deprecated record component, deprecated DTO class (full text-block comparison with minimal options), deprecated Javadoc propagation,since/forRemovalattribute preservation, deprecated getter (no method-level propagation, class-level suppression only, getter call in from-instance constructor), deprecated field type (method-level deprecation + class suppression), deprecated element builder (class-level suppression for collection helper calling deprecated element builder), and framework annotation filtering.