java.lang.management

クラス MemoryNotificationInfo

java.lang.Object

java.lang.management.MemoryNotificationInfo

public class MemoryNotificationInfo
extends Object

メモリー通知に関する情報です。

メモリープールのメモリー使用量がしきい値を超えていることを Java 仮想マシンが検出すると、MemoryMXBean によりメモリー通知が発行されます。発行された通知には、検出された条件に関する次のメモリー通知情報が含まれています。

• メモリープールの名前
• 通知が構築されたときのメモリープールのメモリー使用量
• 通知が構築されたときに、メモリー使用量がしきい値を超えた回数。使用量しきい値通知の場合、このカウントは使用量しきい値カウントになります。コレクション使用量しきい値通知の場合、このカウントはコレクション使用量しきい値カウントになります。

MemoryNotificationInfo オブジェクトを表す CompositeData は、通知のユーザーデータに格納されます。from メソッドは、CompositeData から MemoryNotificationInfo オブジェクトへの変換を行います。たとえば、

      Notification notif;

      // receive the notification emitted by MemoryMXBean and set to notif
      ...

      String notifType = notif.getType();
      if (notifType.equals(MemoryNotificationInfo.MEMORY_THRESHOLD_EXCEEDED) ||
          notifType.equals(MemoryNotificationInfo.MEMORY_COLLECTION_THRESHOLD_EXCEEDED)) {
          // retrieve the memory notification information
          CompositeData cd = (CompositeData) notif.getUserData();
          MemoryNotificationInfo info = MemoryNotificationInfo.from(cd);
          ....
      }
 

MemoryMXBean が発行する通知の型は次のとおりです。

• 使用量しきい値超過通知。
  この通知は、メモリープールのメモリー使用量が増加し、使用量しきい値に達したか超えたときに発行されます。以降、使用量しきい値を超えても、メモリー使用量が使用量しきい値未満に戻るまで、通知は発行されません。

• 使用量しきい値超過通知。
  この通知は、Java 仮想マシンがメモリープールで使用しないオブジェクトのリサイクルに最善を尽くしたあと、メモリープールのメモリー使用量がコレクション使用量しきい値以上であるときに発行されます。

導入されたバージョン:

1.5

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	MEMORY_COLLECTION_THRESHOLD_EXCEEDED Java 仮想マシンがメモリープールで使用しないオブジェクトのリサイクルに最善を尽くしたあと、メモリープールのメモリー使用量がコレクション使用量しきい値以上であることを表す通知型。
static String	MEMORY_THRESHOLD_EXCEEDED メモリープールのメモリー使用量が使用量しきい値に達したか超えたことを表す通知型。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MemoryNotificationInfo(String poolName, MemoryUsage usage, long count) MemoryNotificationInfo オブジェクトを構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
static MemoryNotificationInfo	from(CompositeData cd) 指定された CompositeData によって表される MemoryNotificationInfo オブジェクトを返します。
long	getCount() 通知が構築されたときに、メモリー使用量がしきい値を超えた回数を返します。
String	getPoolName() この通知をトリガーするメモリープールの名前を返します。
MemoryUsage	getUsage() 通知が構築されたときのメモリープールのメモリー使用量を返します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

MEMORY_THRESHOLD_EXCEEDED

public static final String MEMORY_THRESHOLD_EXCEEDED

メモリープールのメモリー使用量が使用量しきい値に達したか超えたことを表す通知型。この通知は MemoryMXBean から出力されます。以降、使用量しきい値を超えても、メモリー使用量が使用量しきい値未満に戻るまで、通知は発行されません。この通知の型の値は java.management.memory.threshold.exceeded です。

関連項目:

定数フィールド値

MEMORY_COLLECTION_THRESHOLD_EXCEEDED

public static final String MEMORY_COLLECTION_THRESHOLD_EXCEEDED

Java 仮想マシンがメモリープールで使用しないオブジェクトのリサイクルに最善を尽くしたあと、メモリープールのメモリー使用量がコレクション使用量しきい値以上であることを表す通知型。この通知は MemoryMXBean から出力されます。この通知の型の値は java.management.memory.collection.threshold.exceeded です。

関連項目:

定数フィールド値

コンストラクタの詳細

MemoryNotificationInfo

public MemoryNotificationInfo(String poolName,
                      MemoryUsage usage,
                      long count)

MemoryNotificationInfo オブジェクトを構築します。

パラメータ:

poolName - この通知をトリガーするメモリープールの名前。

usage - メモリープールのメモリー使用量。

count - しきい値超過回数。

メソッドの詳細

getPoolName

public String getPoolName()

この通知をトリガーするメモリープールの名前を返します。メモリープールの使用量はしきい値を超えました。

戻り値:

この通知をトリガーするメモリープールの名前

getUsage

public MemoryUsage getUsage()

通知が構築されたときのメモリープールのメモリー使用量を返します。

戻り値:

通知が構築されたときのメモリープールのメモリー使用量

getCount

public long getCount()

通知が構築されたときに、メモリー使用量がしきい値を超えた回数を返します。使用量しきい値通知の場合、このカウントは使用量しきい値カウントになります。コレクション使用量しきい値通知の場合、このカウントはコレクション使用量しきい値カウントになります。

戻り値:

通知が構築されたときに、メモリー使用量がしきい値を超えた回数。

from

public static MemoryNotificationInfo from(CompositeData cd)

指定された CompositeData によって表される MemoryNotificationInfo オブジェクトを返します。指定された CompositeData は、次の属性を含む必要があります。

属性名	型
poolName	java.lang.String
usage	javax.management.openmbean.CompositeData
count	java.lang.Long

パラメータ:

cd - MemoryNotificationInfo を表す CompositeData

戻り値:

cd が null でない場合は cd により表される MemoryNotificationInfo オブジェクト、そうでない場合は null。

例外:

IllegalArgumentException - cd が MemoryNotificationInfo オブジェクトを表さない場合。