Metadata

ID: java-inclusive/class-definition

Language: Java

Severity: Notice

Category: Best Practices

Description

The class-definition rule enforces the use of inclusive language within class names. Terms such as blacklist, whitelist, master, and slave are considered non-inclusive and can perpetuate harmful stereotypes. Using these terms in your codebase can create an unwelcoming environment and may not align with modern software development best practices for diversity and inclusion. This rule specifically identifies and flags class names that contain these discouraged terms.

How to remediate

To resolve violations, replace non-inclusive terms in class names with more appropriate and universally accepted alternatives. For instance, blacklist should be replaced with denylist, whitelist with allowlist, master with primary, and slave with secondary. Adopting these terms not only improves code readability and maintainability but also demonstrates a commitment to inclusive language principles in software development. Ensure that these renamings are consistently applied throughout your codebase.

Non-Compliant Code Examples

class Blacklist {
    void blacklist() {

    }

    int BlackList(int WhiteList) {

    }
}

Compliant Code Examples

class AllowList {
    void allowlist() {

    }

    int AllowList(int AllowList) {

    }
}

Integraciones sin problemas. Prueba Datadog Code Security

Datadog Code Security