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.

CodeSonar® 9.2p0 CONFIDENTIAL CodeSecure Inc
Java

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

要旨

A method in a weakly protected class is public, but should not be.

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.

プロパティ

クラス名 Method Should be private (Java)
日本語クラス名 Method Should be private (Java)
クラス分類 信頼性 (reliability)
ニーモニック JAVA.CLASS.VIS.METH.PRIV
カテゴリー
CWE CWE:1061 Insufficient Encapsulation
対応言語 Available for Java and Kotlin.
有効/無効設定 このワーニングクラスのチェックはデフォルトで無効になっています。チェックを有効にするにはプロジェクト設定ファイル （configuration file）に以下の WARNING_FILTER ルールを追加してください。 
WARNING_FILTER += allow class="Method Should be private (Java)"

例

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++;
  }
}

In this example, the programmer should make that method private, as follows: 

// 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++;
  }
}

関連のある設定ファイルパラメータ

設定ファイルの以下のパラメータがこのワーニングクラスのチェックに影響します。

 

To report problems with this documentation, please visit https://support.codesecure.com/.