pmd / pmd/pmd

[java] ShortVariable false positives for generated/inherited methods parameters (e.g. equals)

Open
#4,415 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

an:enhancement
Dominant language
Java
Stars
5.5k
Forks
1.6k
Avg merge
1d 19h
Merged PRs (30d)
54

Description

Affects PMD Version:
6.53.0

Rule:

https://docs.pmd-code.org/latest/pmd_rules_java_codestyle.html#shortvariable

Description:
equals(Object o) and T t intercepted.

Code Sample demonstrating the issue:

@Override
  1. public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }

    Dict dict = (Dict) o;

    return code == dict.code;
  }

2. boolean insert(T t);

Expected outcome:

idea auto generated equals(Object o) and T t, please ignore this,thanks.

Running PMD through: [Maven Plugin]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked ShortVariable rule documentation and reproduce the reported equals(Object o) and insert(T t) examples through the Maven Plugin. Trace the rule's Java implementation and existing tests, if present; done means generated or inherited-method parameters no longer produce these false positives without weakening ordinary short-variable checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.