SONARJAVA-5294 Create rule S7185: @eventlistener methods should have one parameter #4618
Conversation
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
leonardo-pilastri-sonarsource
changed the title
rules/S7185/java/rule.adoc
Outdated
|
|
||
| Spring provides the `@EventListener` annotation to make a method handle some specific types of events. | ||
| This allows to skip the implementation of the `ApplicationListener` interface, making it easier to handle events. | ||
| However, the `@EventListener` annotation can only be used on methods that have at most one parameter, which should be the specific event that we want to handle. |
There was a problem hiding this comment.
Let's add a line break and remove the however.
Suggested change
| However, the `@EventListener` annotation can only be used on methods that have at most one parameter, which should be the specific event that we want to handle. | |
| The `@EventListener` annotation can only be used on methods that have at most one parameter, which should be the specific event that we want to handle. |
rules/S7185/java/rule.adoc
Outdated
| Spring provides the `@EventListener` annotation to make a method handle some specific types of events. | ||
| This allows to skip the implementation of the `ApplicationListener` interface, making it easier to handle events. | ||
| However, the `@EventListener` annotation can only be used on methods that have at most one parameter, which should be the specific event that we want to handle. | ||
| For multiple types of events, we can use the `classes` argument of the annotation, and provide a list of classes of events that we want to handle. |
There was a problem hiding this comment.
Suggested change
| For multiple types of events, we can use the `classes` argument of the annotation, and provide a list of classes of events that we want to handle. | |
| To listen to several types of events, use the `classes` argument of the `@EventListener` annotation. |
|
|
erwan-serandour
approved these changes
Jan 28, 2025
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.
You can preview this rule here (updated a few minutes after each push).
Review
A dedicated reviewer checked the rule description successfully for: