rspec/rules/S899/jvm-description.adoc

When the return value of a function call contains the operation status code, this value should be tested to make sure the operation completed successfully.


This rule raises an issue when the return values of the following are ignored:

* `java.io.File` operations that return a status code (except `mkdirs`)
* `Iterator.hasNext()`
* `Enumeration.hasMoreElements()`
* `Lock.tryLock()`
* non-void ``++Condition.await*++`` methods
* `CountDownLatch.await(long, TimeUnit)`
* `Semaphore.tryAcquire`
* `BlockingQueue`: `offer`, `remove`
Clean rule at root In some cases, the `rule.adoc` at root of a rule is never included anywhere and thus is dead code. It's a maintenance cost by itself, but also it misses opportunities to inline code that seems used by two documents when in fact only one document is actually rendered. And this missed opportunity, in turn, stops us from applying the correct language tag on the code samples. 2023-10-16 16:34:38 +02:00			`When the return value of a function call contains the operation status code, this value should be tested to make sure the operation completed successfully.`

Update rule S899: Return values should not be ignored when they contain the operation status code 2021-09-16 17:42:50 +03:00

			`This rule raises an issue when the return values of the following are ignored:`

			* `java.io.File` operations that return a status code (except `mkdirs`)
			* `Iterator.hasNext()`
			* `Enumeration.hasMoreElements()`
			* `Lock.tryLock()`
Fix broken or dangerous backquotes Co-authored-by: Marco Borgeaud <89914223+marco-antognini-sonarsource@users.noreply.github.com> 2023-10-30 10:33:56 +01:00			* non-void ``++Condition.await*++`` methods
Update rule S899: Return values should not be ignored when they contain the operation status code 2021-09-16 17:42:50 +03:00			* `CountDownLatch.await(long, TimeUnit)`
			* `Semaphore.tryAcquire`
			* `BlockingQueue`: `offer`, `remove`