rspec/rules/S4042/java/rule.adoc

35 lines
956 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
When ``++java.io.File#delete++`` fails, this ``++boolean++`` method simply returns ``++false++`` with no indication of the cause. On the other hand, when ``++java.nio.file.Files#delete++`` fails, this ``++void++`` method returns one of a series of exception types to better indicate the cause of the failure. And since more information is generally better in a debugging situation, ``++java.nio.file.Files#delete++`` is the preferred option.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
----
public void cleanUp(Path path) {
File file = new File(path);
if (!file.delete()) { // Noncompliant
//...
}
}
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
----
public void cleanUp(Path path) throws NoSuchFileException, DirectoryNotEmptyException, IOException {
Files.delete(path);
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
include::highlighting.adoc[]
endif::env-github,rspecator-view[]