Field not used in 'toString()' method

Reports fields that are not used in the toString() method of a class.

Helps discover fields added after the toString() method was last updated. The quick-fix regenerates the toString() method.

In the Generate | toString() dialog, it is possible to exclude fields from this check. This inspection will also check for problems with getter methods if the Enable getters in code generation option is enabled there.

Example:

  public class Relevant {
    private String name; // not used in toString()
    private int index;
    private int length;

    @Override
    public String toString() {
        return "Relevant{" + "index=" + index +
          ", length=" + length + '}';
    }
  }

After the quick-fix is applied:

  public class Relevant {
    private String name;
    private int index;
    private int length;

    @Override
    public String toString() {
        return "Relevant{" + "name='" + name + '\'' +
          ", index=" + index + ", length=" + length + '}';
    }
  }

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

FieldNotUsedInToString

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Java | toString() issues

Availability

By default bundled with: IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,
Can be installed with plugin: Java, 241.18072

Last modified: 18 June 2024