Do not use Using the assignment operator in conditional expressions because it frequently indicates programmer error and can result in unexpected behavior. This means that the The assignment operator should not be used in the following contexts:
if
(controlling expression)while
(controlling expression)do ... while
(controlling expression)for
(second operand)switch
(controlling expression)?:
(first operand)&&
(either operand)||
(either operand)?:
(second or third operands) where the ternary expression is used in any of these contexts
In this noncompliant code example, an assignment expression is the controlling expression in an the if
statement .is an assignment expression:
Code Block |
---|
|
public void f(boolean a, boolean b) {
if (a = b) {
/* ... */
}
}
|
Although the programmer's intent could have been to assign b
to a
and test the value of the result, this usage frequently occurs when the programmer mistakenly used the assignment operator =
rather than the equality operator ==
.
Compliant Solution
When the assignment of b
to a
is unintended, this conditional block is now executed The conditional block shown in this compliant solution executes only when a
is equal to b
:
Code Block |
---|
|
public void f(boolean a, boolean b) {
if (a == b) {
/* ... */
}
}
|
Unintended assignment of b
to a
cannot occur.
Compliant Solution
When the assignment is intended, the following this compliant solution clarifies the programmer's intent:
Code Block |
---|
|
public void f(boolean a, boolean b) {
if ((a = b) == true) {
/* ... */
}
}
|
Compliant Solution
Nevertheless, it It may be preferable clearer to express this same the logic as an explicit assignment followed by a conditionalthe if
condition:
Code Block |
---|
|
public void f(boolean a, boolean b) {
a = b;
if (a) {
/* ... */
}
}
|
In this noncompliant code example, an assignment expression appears in the controlling expression as an operand of the &&
operator. Because &&
is not a comparison operator, assignment is an illegal operand.:
Code Block |
---|
|
public void f(boolean a, boolean b, boolean flag) {
while ( (a = b) && flag ) {
/* ... */
}
}
|
Because &&
is not a comparison operator, assignment is an illegal operand. Again, this is frequently a case of the programmer mistakenly using the assignment operator =
instead of the equals operator ==
.
When the assignment of b
to a
is unintended, this conditional block is now executed only when a
is equal to b
. and flag
is true
:
Code Block |
---|
|
public void f(boolean a, boolean b, boolean flag) {
while ( (a == b) && flag ) {
/* ... */
}
} |
The use of the assignment operator in controlling conditional expressions frequently indicates programmer error and can result in unexpected behavior.
ExceptionallyAs an exception to this guideline, it is permitted to use the assignment operator in conditional expressions if when the assignment is not the controlling expression (that is, the assignment is a subexpression), as shown in the following compliant examplesolution:
Code Block |
---|
|
String line;
public void assignNocontrol(BufferedReader reader = // initialize
)
throws IOException{
String line;
while ((line = reader.readLine()) != null) {
// ... workWork with line
} |
Related Guidelines
Automated Detection
ISO/IEC TR 24772:2013 | Likely Incorrect Expression [KOA] |
MITRE CWE | CWE ID 480, Use of incorrect operator
Bibliography
Section 2§2.7.2, "Errors of Omission and Addition" |
...
...
Image Modified Image Modified Image Modified