Add ImmutablesDefaultValue error-prone check #3245
Open
Conversation
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
This check enforces that default methods in immutable interfaces are annotated with @Value.Default to ensure they are included as fields in the generated immutable classes. Key features: - Detects default methods in @Value.Immutable interfaces - Handles @value.Style(defaultAsDefault = true) configurations - Supports meta-annotations with @value.Style - Provides automatic fixes to add missing @Value.Default annotations - Can be suppressed when methods are auxiliary and not meant as fields
- Add README.md entry documenting the new check - Add link and linkType to BugPattern annotation
The documentation now explicitly mentions that the check is disabled when @value.Style(defaultAsDefault = true) is present either directly on the interface or via meta-annotations, making it clear to users that they can use this approach to avoid the check.
Generate changelog in
|
✅ Successfully generated changelog entry!What happened?Your changelog entries have been stored in the database as part of our migration to ChangelogV3. Need to regenerate?Simply interact with the changelog bot comment again to regenerate these entries. |
pkoenig10
requested changes
Sep 5, 2025
|
This PR has been automatically marked as stale because it has not been touched in the last 14 days. If you'd like to keep it open, please leave a comment or add the 'long-lived' label, otherwise it'll be closed in 7 days. |
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.
This check enforces that default methods in immutable interfaces are
annotated with
@Value.Defaultto ensure they are included as fields inthe generated immutable classes.
@Value.Style(defaultAsDefault = true)configurations@Value.Style@Value.Defaultannotations