JAVA.CLASS.VIS.METH.PRIV : Method Should be private (Java)

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

JAVA.CLASS.VIS.METH.PRIV : Method Should be private (Java)

Summary

We call a class weakly protected if its objects are run in unsafe contexts and so its application programming interface should be as protective as possible. The checker has a built-in set of classes that are considered weakly protected: for example, java.applet.Applet. To specify additional classes should be treated as weakly protected, annotate them with @WeaklyProtected (com.juliasoft.julia.checkers.methodShouldBePrivate.WeaklyProtected).

The checker will not issue a warning for a method that overrides another method, or that is overridden in subclasses.

Properties

Example

In the following code, class MyApplet is weakly protected: public method getNumberOfStart() is defined on an applet.

// MyApplet.java 
import java.applet.Applet;

public class MyApplet extends Applet {
  private int counter;

  @Override
  public void init() {                       // ok: overrides another method 
      counter = 0;
  }

  @Override
  public void start() {                      // ok: overrides another method 
      countOneMoreStart();
  }

  public int getNumberOfStart() {  // "Method Should be private (Java)" warning issued here 
      return counter;
  }

  protected void countOneMoreStart() {       // ok: non-public 
      counter++;
  }
}

// MyApplet.java, after modification 
import java.applet.Applet;

public class MyApplet extends Applet {
  private int counter;

  @Override
  public void init() {
      counter = 0;
  }

  @Override
  public void start() {
      countOneMoreStart();
  }

  private int getNumberOfStart() {
      return counter;
  }

  protected void countOneMoreStart() {
      counter++;
  }
}

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.