This repository has been archived by the owner on May 28, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Java: add guidelines for using assertions
We have a Java coding standard to specify syntax level guidelines. Higher level guidelines such as when to use assertions are not documented. Let's add a document to specify those additional guidelines for Java. Include in that document guidelines for using assertions.
- Loading branch information
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Additional Guidelines - Java | ||
|
||
## Using assertions | ||
|
||
Refer to the article | ||
_[Programming With Assertions](http://docs.oracle.com/javase/8/docs/technotes/guides/language/assert.html)_ | ||
(from Oracle) for more details on the three general guidelines below. | ||
|
||
1. **Do not use assertions to do any work that your application requires for correct operation.**<br> | ||
If you do, the code will not work as expected when assertions are turned off. | ||
|
||
|
||
1. **Do not use assertions for checking _preconditions_/parameters in public methods.**<br> | ||
Those should be enforced by explicit checks that throw particular, | ||
specified exceptions. e.g. `IllegalArgumentException`, `IndexOutOfBoundsException`, or `NullPointerException`. | ||
|
||
|
||
1. **Assertions may be used to check _postconditions_ and class/method _invariants_ in both public | ||
and nonpublic methods.** | ||
|
||
In addition, | ||
|
||
* **Do not handle 'impossible' exceptions using assertions**.<br> | ||
Instead of handling 'impossible' exceptions using an `assert false` as given below, | ||
throw a runtime error such as an `AssertionError`. | ||
|
||
![](Bad.png) | ||
```java | ||
... | ||
} catch (Exception e) { | ||
assert false : "This exception should not happen"; | ||
} | ||
``` | ||
|
||
![](Good.png) | ||
```java | ||
... | ||
} catch (Exception e) { | ||
throw new AssertionError("This exception should not happen"); | ||
} | ||
``` | ||
|
||
> Rationale: As the program flow has already triggered an exception, switching to assertions is not necessary when | ||
> another exception can handle it just as well. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters