モジュール jdk.management
パッケージ com.sun.management

クラスGarbageCollectionNotificationInfo

java.lang.Object
com.sun.management.GarbageCollectionNotificationInfo
すべての実装されたインタフェース:
CompositeDataView
public class GarbageCollectionNotificationInfo extends Object implements CompositeDataView
ガベージ・コレクションに関する情報

Java仮想マシンがガベージ・コレクション・アクションを完了すると、GarbageCollectorMXBeanによってガベージ・コレクション通知が発行されます。発行される通知には、メモリーのステータスに関するガベージ・コレクション通知情報が含まれます:

  • コレクションを実行するために使用されたガベージ・コレクタの名前。
  • ガベージ・コレクタで実行されるアクション。
  • ガベージ・コレクション・アクションの原因。
  • GCサイクル(開始時間、終了時間)とGCサイクル前後のメモリー使用状況に関する統計情報を含むGcInfoオブジェクト。

GarbageCollectionNotificationInfoオブジェクトを表すCompositeDataは、notificationのuserdataに格納されます。 CompositeDataからGarbageCollectionNotificationInfoオブジェクトに変換するために、fromメソッドが提供されます。 次に例を示します。 

      Notification notif;

      // receive the notification emitted by a GarbageCollectorMXBean and set to notif
      ...

      String notifType = notif.getType();
      if (notifType.equals(GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION)) {
          // retrieve the garbage collection notification information
          CompositeData cd = (CompositeData) notif.getUserData();
          GarbageCollectionNotificationInfo info = GarbageCollectionNotificationInfo.from(cd);
          ....
      }

GarbageCollectorMXBeanによって発行される通知の型は、次のとおりです。

  • フィールド詳細

    • GARBAGE_COLLECTION_NOTIFICATION

      public static final String GARBAGE_COLLECTION_NOTIFICATION
      Java仮想マシンがガベージ・コレクションのサイクルを完了したことを示す通知型。 この通知は、GarbageCollectorMXBeanによって発行されます。 この通知型の値はcom.sun.management.gc.notificationです。
      関連項目:
      定数フィールド値

  • コンストラクタの詳細

    • GarbageCollectionNotificationInfo

      public GarbageCollectionNotificationInfo​(String gcName, String gcAction, String gcCause, GcInfo gcInfo)
      GarbageCollectionNotificationInfoオブジェクトを構築します。
      パラメータ:
      gcName - コレクションを実行するために使用されるガベージ・コレクタの名前
      gcAction - ガベージ・コレクタで実行されるアクションの名前
      gcCause - ガベージ・コレクション・アクションの原因
      gcInfo - GCサイクルに関する統計情報を提供するGcInfoオブジェクト

  • メソッドの詳細

    • getGcName

      public String getGcName()
      コレクションを実行するために使用されるガベージ・コレクタの名前を返します
      戻り値:
      コレクションを実行するために使用されるガベージ・コレクタの名前

    • getGcAction

      public String getGcAction()
      ガベージ・コレクタによって実行されたアクションを返します。
      戻り値:
      ガベージ・コレクタによって実行されるアクション

    • getGcCause

      public String getGcCause()
      ガベージ・コレクションの原因を返します。
      戻り値:
      ガベージ・コレクションの原因

    • getGcInfo

      public GcInfo getGcInfo()
      最後のガベージ・コレクションに関連するGC情報を返します。
      戻り値:
      最後のガベージ・コレクションに関連するGC情報

    • from

      public static GarbageCollectionNotificationInfo from​(CompositeData cd)
      指定されたCompositeDataにより表されたGarbageCollectionNotificationInfoオブジェクトを返します。 指定されたCompositeDataは、次の属性を含む必要があります。
      description
      属性名 型
      gcName java.lang.String
      gcAction java.lang.String
      gcCause java.lang.String
      gcInfo javax.management.openmbean.CompositeData
      パラメータ:
      cd - GarbageCollectionNotificationInfoを表すCompositeData
      戻り値:
      cdがnullでない場合はcdにより表されるGarbageCollectionNotificationInfoオブジェクト、そうでない場合はnull。
      例外:
      IllegalArgumentException - cdがGarbaageCollectionNotificationInfoオブジェクトを表さない場合。

    • toCompositeData

      public CompositeData toCompositeData​(CompositeType ct)
      インタフェースからコピーされた説明:CompositeDataView

      このオブジェクト内の値に対応するCompositeDataを返します。 通常、戻り値はCompositeDataSupportのインスタンス、またはwriteReplaceメソッドを介してCompositeDataSupportとして直列化を行うクラスになります。 それ以外の場合、オブジェクトを受信するリモート・クライアントは、再構築を実行できない可能性があります。

      定義:
      toCompositeData 、インタフェース: CompositeDataView
      パラメータ:
      ct - 戻り値の予想されるCompositeType。 戻り値がcdである場合、cd.getCompositeType().equals(ct)はtrueになる。 通常、これは、cdがctをCompositeTypeとして構築されたCompositeDataSupportであるため。
      戻り値:
      CompositeData。