rspec/rules/S1724/rule.adoc
Egon Okerman d1417e82f8
Modify CWE and OWASP Top 10 links to follow standard link format (APPSEC-1134) (#3529)
* Fix all CWE references

* Fix all OWASP references

* Fix missing CWE prefixes
2024-01-15 17:15:56 +01:00

61 lines
1.2 KiB
Plaintext

== Why is this an issue?
Deprecated classes and interfaces should be avoided, rather than used, inherited or extended. Deprecation is a warning that the class or interface has been superseded, and will eventually be removed. The deprecation period allows you to make a smooth transition away from the aging, soon-to-be-retired technology.
=== Noncompliant code example
[source,text]
----
/**
* @deprecated As of release 1.3, replaced by {@link #Fee}
*/@Deprecated
class Foo { ... }
class Bar extends Foo { ... }
----
=== Compliant solution
[source,text]
----
class Bar extends Fee { ... }
----
=== Exceptions
When the class that extends a deprecated class is itself deprecated, the extending class will be ignored.
[source,text]
----
@Deprecated
class Bar extends Foo { ... } // compliant Bar is deprecated.
----
== Resources
* CWE - https://cwe.mitre.org/data/definitions/477[CWE-477 - Use of Obsolete Functions]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
"XXX" is deprecated, [extend|implement] the suggested replacement instead.
'''
== Comments And Links
(visible only on this page)
=== is related to: S2214
endif::env-github,rspecator-view[]