Programmers frequently make errors regarding the precedence of operators because of the unintuitive unintuitively low - precedence levels of {{ Wiki Markup &
}}, {{\|
}}, {{\^
}}, {{<<
}}, and {{>>
}}. Avoid mistakes regarding precedence through the suitable use of parentheses. This also improves code readability unless taken to excess. The precedence of operations by the order of the subclauses are defined in the Java Tutorials \[[Tutorials 2008|AA. References#Tutorials 08]\parentheses, which also improves code readability. The precedence of operations by the order of the subclauses is defined in the Java Tutorials [Tutorials 2013].
Although it advises against depending on parentheses for specifying evaluation order , guideline EXP08EXP05-J. Do not write more than once to the same variable follow a write by a subsequent write or read of the same object within an expression applies only to expressions that contain side effects.
...
The intent of the expression in this noncompliant code example is to add the variable OFFSET
to the result of the bitwise logical AND between x
and MASK
.:
Code Block | ||
---|---|---|
| ||
public static final int MASK = 1337;
public static final int OFFSET = -1337;
public static int computeCode(int x) {
return x & MASK + OFFSET;
}
|
According to the operator precedence guidelines, the expression is parsed as the following:
Code Block |
---|
x & (MASK + OFFSET)
|
This expression gets is evaluated , as follows, resulting in the value 0.:
Code Block |
---|
x & (1337 - 1337)
|
Compliant Solution
This compliant solution uses parentheses to ensure that the expression evaluates is evaluated as intended.:
Code Block | ||
---|---|---|
| ||
public static final int MASK = 1337;
public static final int OFFSET = -1337;
public static int computeCode(int x) {
return (x & MASK) + OFFSET;
}
|
Exceptions
Noncompliant Code Example
In this noncompliant code example, the intent is to append either "0" or "1" to the string "value=
":
Code Block | ||
---|---|---|
| ||
public class PrintValue {
public static void main(String[] args) {
String s = null;
// Prints "1"
System.out.println("value=" + s == null ? 0 : 1);
}
}
|
However, the precedence rules result in the expression to be printed being parsed as ("value=" + s) == null ? 0 : 1
.
Compliant Solution
This compliant solution uses parentheses to ensure that the expression evaluates as intended:
Code Block | ||
---|---|---|
| ||
public class PrintValue {
public static void main(String[] args) {
String s = null;
// Prints "value=0" as expected
System.out.println("value=" + (s == null ? 0 : 1));
}
}
|
Applicability
Mistakes regarding precedence guidelines can cause an expression to be evaluated in an unintended way, which can lead to unexpected and abnormal program behavior.
EXP06-EX0: Parentheses may be omitted from mathematical expressions that follow the algebraic precedence rules. For instance, consider the following expression:
Code Block |
---|
x + y * z
|
By mathematical convention, multiplication is performed before addition; parentheses are redundant in this case.:
Code Block | ||
---|---|---|
| ||
x + (y * z)
|
Risk Assessment
Mistakes regarding precedence guidelines can cause an expression to be evaluated in an unintended way. This can lead to unexpected and abnormal program behavior.
...
Guideline
...
Severity
...
Likelihood
...
Remediation Cost
...
Priority
...
Level
...
EXP06-J
...
low
...
probable
...
medium
...
...
L3
Automated Detection
Detection of all expressions using low-precedence operators without parentheses is straightforward. Determining the correctness of such uses is infeasible in the general case; , although heuristic warnings could be useful.
Related Guidelines
C Coding Standard: EXP00-C. Use parentheses for precedence of operation
C++ Secure Coding Standard: EXP00-CPP. Use parentheses for precedence of operation
Bibliography
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Parasoft Jtest |
| CERT.EXP53.APAREN | Use '()' to separate complex expressions | ||||||
SonarQube |
| S864 |
Bibliography
[ESA 2005] | Rule 65, |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="188a1c6f-f960-48b1-a390-a22f315162bd"><ac:plain-text-body><![CDATA[
[[ESA 2005
AA. References#ESA 05]]
Use parentheses to explicitly indicate the order of execution of numerical operators |
]]></ac:plain-text-body></ac:structured-macro>
[ |
[[Tutorials 2008
AA. References#Tutorials 08]]
http://java.sun.com/docs/books/tutorial/java/nutsandbolts/expressions.html]
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="510274ec-a031-4a42-97a8-f1d7894d5fbc"><ac:plain-text-body><![CDATA[
[[Rogue 2000
AA. References#Rogue 2000]]
Rule 77: Clarify the order of operations with parentheses
]]></ac:plain-text-body></ac:structured-macro>
...
EXP51-J. Do not perform assignments in conditional statements 02. Expressions (EXP)