ImmutablesInterfaceDefaultValue check for config interfaces. #2968
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.
Re-opening #1761, but only applying the check to config Immutables. It would be better if the server library could tell us which Classes are Config classes, but currently this PR checks for an
@ImmutablesConfigStyle
annotation.Before this PR
In code reviews, noticed some uses of
@Value.Immutable
on default methods in interfaces without corresponding@Value.Default
,@Value.Lazy
or@Value.Derived
.It is sometimes the case that default methods are used for helper functions that should not be serialized or included in builders, meaning that it would not be correct to require one of those annotations in all cases. This PR gives the option to annotate with
@JsonIgnore
to encourage the programmer to more clearly specify their intent.After this PR
==COMMIT_MSG==
ImmutablesInterfaceDefaultValue check for config interfaces.
==COMMIT_MSG==
Possible downsides?
@Value.Default
was intended if not already annotated@Value.Lazy
or@Value.Derived
.@JsonIgnore
requires the Jackson library.