Check variable assignment language

Metadata

ID: java-inclusive/variable-assignment

Language: Java

Severity: Notice

Category: Best Practices

Description

Ensure that certain words are not used in the codebase and suggest alternatives when appropriate.

Examples of alternative suggestions:

  • blacklist with denylist
  • whitelist with allowlist
  • master with primary
  • slave with secondary

Non-Compliant Code Examples

class Blacklist {
    void blacklist() {
        whitelist = 1;
        this.whitelist = 1;
    }

    int BlackList(int WhiteList) {
        int blacklist = 42;
    }
}

Compliant Code Examples

class AllowList {
    void allowlist() {
        allowlist = 1;
    }

    int AllowList(int AllowList) {
        int denylist = 42;
    }
}