org.sonar.l10n.java.rules.squid.ClassVariableVisibilityCheck.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.6.0.37351

Public class variable fields do not respect the encapsulation principle and has three main disadvantages:

 Additional behavior such as validation cannot be added.
 The internal representation is exposed, and cannot be changed afterwards.
 Member values are subject to change from anywhere in the code and may not meet the programmer's assumptions.

By using private attributes and accessor methods (set and get), unauthorized modifications are prevented.
Noncompliant Code Example

public class MyClass {

  public static final int SOME_CONSTANT = 0;     // Compliant - constants are not checked

  public String firstName;                       // Noncompliant

}

Compliant Solution

public class MyClass {

  public static final int SOME_CONSTANT = 0;     // Compliant - constants are not checked

  private String firstName;                      // Compliant

  public String getFirstName() {
    return firstName;
  }

  public void setFirstName(String firstName) {
    this.firstName = firstName;
  }

}

Exceptions
Because they are not modifiable, this rule ignores public final fields.

See


 MITRE, CWE-493 - Critical Public Variable Without Final Modifier