Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Changed to JG and corrected code examples

Do not use the assignment operator in the outermost expression of an if or switch statement or a looping statement (while, do, or for) because it typically indicates programmer error and can result in unexpected behavior.

Noncompliant Code Example

In this noncompliant code example, an assignment expression is the outermost expression in an if statement.

Code Block
bgColor#FFcccc

public void exampleFunction(Objectboolean a, Objectboolean b){

  if (a = b) {
    /* ... */
  }

}

Although the intent of the code could be to assign b to a and test the value of the result for equality to zero, it is frequently a case of the programmer mistakenly using the assignment operator = instead of the equals operator ==.

Compliant Solution

When the assignment of b to a is unintended, this conditional block is now executed when a is equal to b.

Code Block
bgColor#ccccff

public void exampleFunction(Objectboolean a, Objectboolean b){

  if (a == b) {
    /* ... */
  }

}

When the assignment is intended, the following compliant solution may be used because the programmer's intent is clearer:

Code Block
bgColor#ccccff

public void exampleFunction(Objectboolean a, Objectboolean b){


  if ((a = b) == true) {
    /* ... */
  }

}

But it might be preferable to express this same logic as an assignment followed by a conditional:

Code Block
bgColor#ccccff

public void exampleFunction(Objectboolean a, Objectboolean b){

  a = b;
  if (a == 0) {
    /* ... */
  }

}

Risk Assessment

Errors of omission can result in unintended program flow.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

EXP04EXP51-J JG

low

likely

medium

P6

L2

Related Guidelines

Bibliography

[Hatton 1995]

Section 2.7.2, "Errors of omission and addition"

 

EXP03-J. Do not use the equality operators when comparing values of boxed primitivesImage Removed      02. Expressions (EXP)      EXP05-J. Do not write more than once to the same variable within an expression