org.sonar.l10n.java.rules.squid.S2694.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-checks Show documentation

There is a newer version: 8.9.0.37768


  A non-static inner class has a reference to its outer class, and access to the outer class' fields and methods.
  That class reference makes the inner class larger and could cause the outer class instance to live in memory longer than necessary.


  If the reference to the outer class isn't used, it is more efficient to make the inner class static (also called nested).
  If the reference is used only in the class constructor, then explicitly pass a class reference to the constructor.
  If the inner class is anonymous, it will also be necessary to name it.


  However, while a nested/static class would be more efficient,
  it's worth nothing that there are semantic differences between an inner class and a nested one:


  an inner class can only be instantiated within the context of an instance of the outer class.
  a nested (static) class can be instantiated independently of the outer class.


Noncompliant Code Example
public class Fruit {
  // ...

  public class Seed {  // Noncompliant; there's no use of the outer class reference so make it static
    int germinationDays = 0;
    public Seed(int germinationDays) {
      this.germinationDays = germinationDays;
    }
    public int getGerminationDays() {
      return germinationDays;
    }
  }
}


Compliant Solution
public class Fruit {
  // ...

  public static class Seed {
    int germinationDays = 0;
    public Seed(int germinationDays) {
      this.germinationDays = germinationDays;
    }
    public int getGerminationDays() {
      return germinationDays;
    }
  }
}