Inclusive Variable Assignment

ID

java.inclusive_variable

Severity

info

Remediation Complexity

trivial

Remediation Risk

medium

Remediation Effort

low

Resource

Naming Convention

Language

Java

Tags

inclusive, naming

Description

Reports field, local variable and parameter declarations whose name contains a non-inclusive term (blacklist/whitelist, master/slave, grandfather, dummy, sanity).

Rationale

See java.inclusive_class / java.inclusive_function. Consistency across types, methods and variables is what makes the replacement stick — flagging only types and methods while leaving variable names unchanged defeats the purpose.

// Bad
List<String> userBlacklist;
String masterPassword;
int dummyValue = 0;

// Good
List<String> userDenylist;
String primaryPassword;
int placeholderValue = 0;

Remediation

Rename the variable using a neutral equivalent. See java.inclusive_class for the substitution table.

Configuration

The list of non-inclusive terms is configurable via the terms property. See java.inclusive_class for details.