rspec/rules/S2062/java/rule.adoc

55 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
The ``++readResolve()++`` method allows final tweaks to the state of an object during deserialization. Non-final classes which implement ``++readResolve()++``, should not set its visibility to ``++private++`` since it will then be unavailable to child classes.
=== 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 Fruit implements Serializable {
private static final long serialVersionUID = 1;
private Object readResolve() throws ObjectStreamException // Noncompliant
{...}
//...
}
public class Raspberry extends Fruit implements Serializable { // No access to parent's readResolve() method
//...
}
----
=== 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 Fruit implements Serializable {
private static final long serialVersionUID = 1;
protected Object readResolve() throws ObjectStreamException
{...}
//...
}
public class Raspberry extends Fruit implements Serializable {
//...
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Make this class "private" or elevate the visibility of "readResolve".
endif::env-github,rspecator-view[]