rspec/rules/S5329/java/rule.adoc

44 lines
1.6 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
It is very common to pass a collection constructor reference as an argument, for example ``++Collectors.toCollection(ArrayList::new)++`` takes the ``++ArrayList::new++`` constructor. When the method expects a ``++java.util.function.Supplier++`` it is perfectly fine. However when the method argument type is ``++java.util.function.Function++`` it means that an argument will be passed to the constructor.
2021-04-28 16:49:39 +02:00
The first argument of Collections constructors is usually an integer representing its "initial capacity". This is generally not what the developer expects, but the memory allocation is not visible at first glance.
This rule raises an issue when a collection constructor is passed by reference as a ``++java.util.function.Function++`` argument.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
Arrays.asList(1, 2, 54000).stream().collect(Collectors.toMap(Function.identity(), ArrayList::new)); // Noncompliant, "ArrayList::new" unintentionally refers to "ArrayList(int initialCapacity)" instead of "ArrayList()"
2021-04-28 16:49:39 +02:00
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
Arrays.asList(1, 2, 54000).stream().collect(Collectors.toMap(Function.identity(), id -> new ArrayList<>())); // Compliant, explicitly show the usage of "id -> new ArrayList<>()" or "id -> new ArrayList<>(id)"
2021-04-28 16:49:39 +02:00
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Replace this constructor reference with a lambda returning a new ``++List/HashMap/...++``.
=== Highlighting
The constructor reference.
endif::env-github,rspecator-view[]