rspec/rules/S2063/java/rule.adoc

42 lines
936 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
A non-serializable ``++Comparator++`` can prevent an otherwise-``++Serializable++`` ordered collection from being serializable. Since the overhead to make a ``++Comparator++`` serializable is usually low, doing so can be considered good defensive programming.
=== 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
----
public class FruitComparator implements Comparator<Fruit> { // Noncompliant
int compare(Fruit f1, Fruit f2) {...}
boolean equals(Object obj) {...}
}
----
=== 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
----
public class FruitComparator implements Comparator<Fruit>, Serializable {
private static final long serialVersionUID = 1;
int compare(Fruit f1, Fruit f2) {...}
boolean equals(Object obj) {...}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
* Make this class "Serializable".
endif::env-github,rspecator-view[]