New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Issue #6440: AnnotationLocation: named parameters must be considered parameters #6444
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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 file contains 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 file contains 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 file contains 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 file contains 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
36 changes: 36 additions & 0 deletions
36
...ools/checkstyle/checks/annotation/annotationlocation/InputAnnotationLocationMultiple.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package com.puppycrawl.tools.checkstyle.checks.annotation.annotationlocation; | ||
|
|
||
| import java.lang.annotation.Repeatable; | ||
|
|
||
| /** | ||
| * This test-input is intended to be checked using following configuration: | ||
| * | ||
| * allowSamelineSingleParameterlessAnnotation = false | ||
| * allowSamelineParameterizedAnnotation = false | ||
| * allowSamelineMultipleAnnotations = true | ||
| */ | ||
|
|
||
| class InputAnnotationLocationMultiple { | ||
|
|
||
| @Annotation void singleParameterless() {} | ||
|
|
||
| @Annotation @Annotation void multipleParameterless() {} | ||
|
|
||
| @Annotation("") void parameterized() {} | ||
|
|
||
| @Annotation(value = "") void namedParameterized() {} | ||
|
|
||
| @Annotation @Annotation("") @Annotation(value = "") void multiple() {} | ||
|
|
||
| @Annotation("") @Annotation(value = "") void multipleParametrized() {} | ||
|
|
||
| @Repeatable(Annotations.class) | ||
| @interface Annotation { | ||
| String value() default ""; | ||
| } | ||
|
|
||
| @interface Annotations { | ||
| Annotation[] value(); | ||
| } | ||
|
|
||
| } | ||
36 changes: 36 additions & 0 deletions
36
...checkstyle/checks/annotation/annotationlocation/InputAnnotationLocationParameterized.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package com.puppycrawl.tools.checkstyle.checks.annotation.annotationlocation; | ||
|
|
||
| import java.lang.annotation.Repeatable; | ||
|
|
||
| /** | ||
| * This test-input is intended to be checked using following configuration: | ||
| * | ||
| * allowSamelineSingleParameterlessAnnotation = false | ||
| * allowSamelineParameterizedAnnotation = true | ||
| * allowSamelineMultipleAnnotations = false | ||
| */ | ||
|
|
||
| class InputAnnotationLocationParameterized { | ||
|
|
||
| @Annotation void singleParameterless() {} //warn | ||
|
|
||
| @Annotation @Annotation void multipleParameterless() {} //warn | ||
|
|
||
| @Annotation("") void parameterized() {} | ||
|
|
||
| @Annotation(value = "") void namedParameterized() {} | ||
|
|
||
| @Annotation @Annotation("") @Annotation(value = "") void multiple() {} //warn | ||
|
|
||
| @Annotation("") @Annotation(value = "") void multipleParametrized() {} //warn | ||
|
|
||
| @Repeatable(Annotations.class) | ||
| @interface Annotation { | ||
| String value() default ""; | ||
| } | ||
|
|
||
| @interface Annotations { | ||
| Annotation[] value(); | ||
| } | ||
|
|
||
| } |
36 changes: 36 additions & 0 deletions
36
...tyle/checks/annotation/annotationlocation/InputAnnotationLocationSingleParameterless.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package com.puppycrawl.tools.checkstyle.checks.annotation.annotationlocation; | ||
|
|
||
| import java.lang.annotation.Repeatable; | ||
|
|
||
| /** | ||
| * This test-input is intended to be checked using following configuration: | ||
| * | ||
| * allowSamelineSingleParameterlessAnnotation = true | ||
| * allowSamelineParameterizedAnnotation = false | ||
| * allowSamelineMultipleAnnotations = false | ||
| */ | ||
|
|
||
| class InputAnnotationLocationSingleParameterless { | ||
|
|
||
| @Annotation void singleParameterless() {} | ||
|
|
||
| @Annotation @Annotation void multipleParameterless() {} //warn | ||
|
|
||
| @Annotation("") void parameterized() {} //warn | ||
|
|
||
| @Annotation(value = "") void namedParameterized() {} //warn | ||
|
|
||
| @Annotation @Annotation("") @Annotation(value = "") void multiple() {} //warn | ||
|
|
||
| @Annotation("") @Annotation(value = "") void multipleParametrized() {} //warn | ||
|
|
||
| @Repeatable(Annotations.class) | ||
| @interface Annotation { | ||
| String value() default ""; | ||
| } | ||
|
|
||
| @interface Annotations { | ||
| Annotation[] value(); | ||
| } | ||
|
|
||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we have some warnings in this file ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. with
allowSamelineMultipleAnnotations = truebothallowSamelineSingleParameterlessAnnotationandallowSamelineParameterizedAnnotationhas no effect. Actually, this means that any combination of annotations is allowed.However, it is possible to catch a violation by using annotations on different lines.
This one: https://github.com/checkstyle/checkstyle/blob/master/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationLocationCheck.java#L292
But this is a different case and should be covered by another set of tests.