Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note
titleDeprecated

This rule may be deprecated and replaced by a similar guideline.

06/28/2014 -- Version 1.0

 According to The Java Language Specification (JLS), §15According to the Java Language Specification §15.7, "Evaluation Order" [JLS 2015]:

The Java programming language guarantees that the operands of operators appear to be evaluated in a specific evaluation order, namely, from left to right.

§15§15.7.3, "Evaluation Respects Parentheses and Precedence" of the Java Language Specification adds:

Java programming language implementations must respect the order of evaluation as indicated explicitly by parentheses and implicitly by operator precedence.

These When an expression contains side effects, these two requirements can be counter-intuitive when expressions contain side-effectsyield unexpected results. Evaluation of the operands proceeds left - to - right, without regard to operator precedence rules and indicative parentheses; evaluation of the operators, however, obeys precedence rules and parentheses.

Expressions should never must not write to memory that they subsequently read , and they should never and also must not write to any memory twice. Memory writing and reading Note that memory reads and writes can occur either directly in the expression from assignments or indirectly through side effects in functions methods called in the expression.

Noncompliant Code Example (Order of Evaluation)

This noncompliant code example shows how side effects in expressions can lead to unanticipated outcomes. The programmer intends to write access control logic based on different threshold levelsthresholds. Each user has a rating that must be above the threshold to be granted access. As shown, a simple function can calculate the rating. The get() method is expected to return a non-zero factor value for authorized users who are authorized, and a zero value for those who are unauthorized users.

In this case, the programmer expects the rightmost subexpression to evaluate The programmer in this example incorrectly assumes that the rightmost subexpression is evaluated first because the * operator has a higher precedence than the + operator . The parentheses reinforce this belief. These ideas lead and because the subexpression is parenthesized. This assumption leads to the incorrect conclusion that the right hand side evaluates to zero whenever the get() method returns zero. The programmer expects number to be that number is assigned 0 because of the rightmost number = get() subexpression. Consequently, the test in the left-hand subexpression is expected to reject the unprivileged user because the rating value (of number) is below the threshold of 10.

However, the program grants access to the unauthorized user because evaluation of the side-effect-infested subexpressions follows the left-to-right ordering rule.

Code Block
bgColor#FFcccc

class BadPrecedence {
  public static void main(String[] args) {
    int number = 17;
    int[] threshold = new int[20];
    threshold[0] = 10;
    number = (number > threshold[0] ? 0 : -2) 
             + ((31 * ++number) * (number = get()));
    // ... 
    if (number == 0) {
      System.out.println("Access granted");
    } else {
      System.out.println("Denied access"); // number = -2
    }
  }

  public static int get() {
    int number = 0;
    // Assign number to nonnonzero zero value if authorized, else 0
    return number;
  }
}

Noncompliant Code Example (Order of Evaluation)

This noncompliant code example reorders the previous expression so that the left-to-right evaluation order of the operands corresponds with the programmer's intent. Although this code performs as expected, it still represents poor practice by writing to number three times in a single expression.

Code Block
bgColor#ccccff#ffcccc

number = ((31 * ++number) * (number=get())) + (number > threshold[0] ? 0 : -2);

Compliant Solution (Order of Evaluation)

This compliant solution uses equivalent code with no side - effects . It performs only one write, to numberand performs not more than one write per expression. The resulting expression can be reordered without concern for the evaluation order of the component expressions, making the code easier to understand and maintain.

Code Block
bgColor#ccccff

final int authnum = get();
number = ((31 * (number + 1)) * authnum) + (authnum > threshold[0] ? 0 : -2);

Exceptions

EXP08EXP05-J-EX1EX0: The postfix increment and postfix decrement operators (++) and (--) read a numeric variable, and then assign a new value to a the variable and then subsequently read it. These are . Although these operators read and modify a value, they are well-understood and are an exception to the rule against reading memory that was written in the same expression.this rule. This exception does not apply if a value modified by an increment or decrement operator is subsequently read or written.

EXP05-J-EX1: The conditional-or || and conditional-and && operators have well-understood semantics. Writes followed by subsequent writes or reads do not violate this rule if they occur in different operands of || or &&EXP08-EX2: The logical operators || and && have well-understood short-circuit semantics, so expressions involving these operators may violate this rule. Consider the following code example:

Code Block
bgColor#ccccff

public void exampleMethod(InputStream in;) {
  int i;
  // SkipProcess onechars char,until process'' nextfound
  while ((i = in.read()) != -1 && i != '\'' && 
         (i = in.read()) != -1 && i != '\'') {
    // ...
  }

}

Although the overall conditional expression violates this guideline, this code is compliant because the sub-expressions on either side of the && operator do not violate it. Each has exactly This rule is not violated by the controlling expression of the while loop because the rule is not violated by any operand to the conditional-and && operators. The subexpressions (i = in.read()) != -1 have one assignment and one side effect (the reading of a character from in).

Risk Assessment

Failure to understand the evaluation order of expressions containing side effects can result in unexpected output.

Recommendation

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

EXP08

EXP05-J

low

Low

unlikely

Unlikely

medium

Medium

P2

L3

Automated Detection

Detection of all expressions involving both side - effects and also multiple operator precedence levels is straightforward. Determining the correctness of such uses is infeasible in the general case; heuristic warnings could be useful.

ToolVersionCheckerDescription
Parasoft Jtest

Include Page
Parasoft_V
Parasoft_V

CERT.EXP05.CIDAvoid using increment or decrement operators in nested expressions
PVS-Studio

Include Page
PVS-Studio_V
PVS-Studio_V

V6044
SonarQube
Include Page
SonarQube_V
SonarQube_V
S881Increment (++) and decrement (--) operators should not be used in a method call or mixed with other operators in an expression


Related Guidelines

...

...

...

...

...

for side effects

ISO/IEC TR 24772:2010

Side Effects and Order of Evaluation [SAM]

Bibliography

...


...

Image Added Image Added Image Added[JLS 2005|AA. Bibliography#JLS 05]\] [§15.7|http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.7] "Evaluation Order" and [§15.7.3|http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.7.3] "Evaluation Respects Parentheses and Precedence"Image Removed      02. Expressions (EXP)      EXP09-J. Do not use side-effecting expressions in assertions