[FEAT][Java] Annotate Generated Enum-classes with `@Generated`
Draft
CH
5mo ago+1667+1667+0123456789012345678901234567890123456789-193-193-012345678901234567890123456789
Annotates generated enum-classes with @Generated - both inner and outer. Using ANY java-library. The @Generated-annotation will be imported dynamically based on the choice of Jakarta / JavaX. NOTE: While this is intended to be non-breaking, if this annotation is currently manually added (via configOptions or vendor-extensions), these MUST be removed because @Generated-annotations are NOT repeatable. This fixes #23832
PR checklist
- Read the contribution guidelines.
- Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
- Run the following to build the project and update samples:
(For Windows users, please run the script in WSL)./mvnw clean package || exit ./bin/generate-samples.sh ./bin/configs/*.yaml || exit ./bin/utils/export_docs_generators.sh || exit
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed. - File the PR against the correct branch:
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks) - If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having
"fixes #123"present in the PR description) - If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Summary by cubic
Adds @Generated to all generated Java enums (top-level and inner) so tools can recognize and ignore generated code. Aligns enums with other generated classes.
-
Bug Fixes
- Inserted
{{>generatedAnnotation}}before enum declarations across Java generators:microprofile,native,okhttp-gson,JavaInflector,JavaJaxRS(CXF, RESTEasy, Spec),JavaSpring,JavaPlayFramework,JavaVertXServer,java-helidon(clientmp/se, servermp/se),java-msf4j-server,java-pkmst,java-undertow-server,java-micronaut; excludesjava-vertx-web. - Emits
javax.annotation.Generatedorjakarta.annotation.Generatedbased on generator settings; adds a line break after the annotation. - Set
hideGenerationTimestamp: truein sample generation configs and regenerated Java samples to include the annotation on all enums.
- Inserted
-
Migration
- No action needed. If you manually add
@Generatedto enums, remove it to avoid duplicates; and for JDK 9+ with thejavaxvariant, addjavax.annotation:javax.annotation-apito the classpath.
- No action needed. If you manually add