rspec/rules/S1181/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

50 lines
1.3 KiB
Plaintext

== Why is this an issue?
``++Throwable++`` is the superclass of all errors and exceptions in Java. ``++Error++`` is the superclass of all errors, which are not meant to be caught by applications.
Catching either ``++Throwable++`` or ``++Error++`` will also catch ``++OutOfMemoryError++`` and ``++InternalError++``, from which an application should not attempt to recover.
=== Noncompliant code example
[source,java]
----
try { /* ... */ } catch (Throwable t) { /* ... */ }
try { /* ... */ } catch (Error e) { /* ... */ }
----
=== Compliant solution
[source,java]
----
try { /* ... */ } catch (RuntimeException e) { /* ... */ }
try { /* ... */ } catch (MyException e) { /* ... */ }
----
== Resources
* https://cwe.mitre.org/data/definitions/396[MITRE, CWE-396] - Declaration of Catch for Generic Exception
* https://wiki.sei.cmu.edu/confluence/display/java/ERR08-J.+Do+not+catch+NullPointerException+or+any+of+its+ancestors[CERT, ERR08-J.] - Do not catch NullPointerException or any of its ancestors
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Catch Exception instead of [Throwable|Error]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]