Skip to content

Issue #3730: Add type annotation tokens to AnnotationLocation check #17970

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Issue #3730: Add type annotation tokens to AnnotationLocation check #17970

wants to merge 1 commit into from

Conversation

@Hariom-kr
Copy link
Contributor

@Hariom-kr Hariom-kr commented Oct 22, 2025 •
edited
Loading

#3730
Summary:
New tokens:

  • TYPECAST - Annotations on type casts
  • TYPE_ARGUMENT - Annotations on generic type arguments
  • DOT - Annotations in qualified type names
  • LITERAL_NEW - Annotations on constructor invocations
  • LITERAL_THROWS - Annotations on exception types in throws clauses
  • IMPLEMENTS_CLAUSE - Annotations on interface types in implements clauses

Decision:

  • Tokens are opt-in only (not enabled in default configurations)
  • Added to getAcceptableTokens() but not getDefaultTokens()
  • Type annotations are less common and inline formatting is often preferred
  • Users can explicitly enable these tokens when needed for their codebase

Changes:

  • Updated AnnotationLocationCheck.java to accept the six new tokens
  • Added comprehensive documentation examples (Example5-Example10)
  • Updated xdocs template with new example sections
  • Added tokens to test ignore lists for checkstyle and google configs

@Hariom-kr
Copy link
Contributor Author

Github, generate website

@github-actions
Copy link
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/e215b85_20251022075714/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/e215b85_20251022075714/checks/annotation/annotationlocation.html#Properties

@Hariom-kr Hariom-kr force-pushed the annotationlocation-xdoc-ex branch from e215b85 to 05b9872 Compare October 22, 2025 10:59
@Hariom-kr
Copy link
Contributor Author

Github, generate website

@Hariom-kr Hariom-kr force-pushed the annotationlocation-xdoc-ex branch from 05b9872 to 2210ee7 Compare October 22, 2025 11:21
@github-actions
Copy link
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/05b9872_20251022111842/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/05b9872_20251022111842/checks/annotation/annotationlocation.html#Properties

@Hariom-kr
Copy link
Contributor Author

@romani can u review plz?

@Hariom-kr Hariom-kr force-pushed the annotationlocation-xdoc-ex branch from 2210ee7 to b62546f Compare October 23, 2025 03:34
@Hariom-kr
Copy link
Contributor Author

Github, generate website

@github-actions
Copy link
Contributor

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/b62546f_20251023035210/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/b62546f_20251023035210/checks/annotation/annotationlocation.html#Properties

@Hariom-kr
Copy link
Contributor Author

Hariom-kr commented Oct 25, 2025 •
edited
Loading

@romani can u review plz?

romani
romani requested changes Oct 27, 2025
View reviewed changes
Copy link
Member

@romani romani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

items:

...resources/com/puppycrawl/tools/checkstyle/checks/annotation/annotationlocation/Example5.java

// xdoc section -- start
class Example5 {
List<@TypeArgAnnotation1 String> names; // ok
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove all OK comments.
in all files.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay

@romani
Copy link
Member

romani commented Oct 27, 2025

annotation is not over "implements" it is over type that is after implements.
same for ..

I need a bit more time to this issue, something is weird in it.

@Hariom-kr
Copy link
Contributor Author

yes, annotation on keyword is not allowed na i will wait for further instructions..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@romani romani romani requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Hariom-kr @romani