rspec/rules/S107/java/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

71 lines
2.0 KiB
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
With a maximum number of 4 parameters:
[source,java]
----
public void doSomething(int param1, int param2, int param3, String param4, long param5) {
...
}
----
=== Compliant solution
[source,java]
----
public void doSomething(int param1, int param2, int param3, String param4) {
...
}
----
=== Exceptions
Methods annotated with :
* Spring's ``++@RequestMapping++`` (and related shortcut annotations, like ``++@GetRequest++``)
* JAX-RS API annotations (like ``++@javax.ws.rs.GET++``)
* Bean constructor injection with ``++@org.springframework.beans.factory.annotation.Autowired++``
* CDI constructor injection with ``++@javax.inject.Inject++``
* ``++@com.fasterxml.jackson.annotation.JsonCreator++``
* Micronaut's annotations (like ``++@io.micronaut.http.annotation.Get++``)
may have a lot of parameters, encapsulation being possible. Such methods are therefore ignored.
Also, if a class annotated as a Spring component (like ``++@org.springframework.stereotype.Component++``) has a single
constructor, that constructor will be considered ``++@Autowired++`` and ignored by the rule.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
'''
== Comments And Links
(visible only on this page)
=== on 25 Oct 2018, 00:04:10 Vishal Mirza wrote:
!RequestMapping Annotation Not Ignored.png!
Hi,
I have been using the SonarJava 5.8 updated plugin and I still see RequestMapping annotation is not being ignored by SonarQube. Attached is the image of code snippet(sorry I have to hide the names due to the company policies). Can someone tell me how to make it work?
Thanks
=== on 25 Oct 2018, 16:01:54 Ann Campbell wrote:
\[~vishal.mirza] to start a discussion, please go to the https://community.sonarsource.com[SonarQube Community]
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]