Class MemoryNotificationInfo
java.lang.management
java.lang.Object
  java.lang.management.MemoryNotificationInfo

public class MemoryNotificationInfo
extends Object
The information about a memory notification.

A memory notification is emitted by MemoryMXBean when the Java virtual machine detects that the memory usage of a memory pool is exceeding a threshold value. The notification emitted will contain the memory notification information about the detected condition:

A CompositeData representing the MemoryNotificationInfo object is stored in the user data of a notification. The from method is provided to convert from a CompositeData to a MemoryNotificationInfo object. For example:

      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);
          ....
      }  
 

The types of notifications emitted by MemoryMXBean are:

Since:
1.5
Version:
1.8, 03/08/06
Author:
Mandy Chung

Field Summary
static String
MEMORY_COLLECTION_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool is greater than or equal to its collection usage threshold after the Java virtual machine has expended effort in recycling unused objects in that memory pool.
static String
MEMORY_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool has reached or exceeded its usage threshold value.
Constructor Summary
MemoryNotificationInfo(String poolName, MemoryUsage usage, long count)
Constructs a MemoryNotificationInfo object.
Method Summary
from(javax.management.openmbean.CompositeData cd)
Returns a MemoryNotificationInfo object represented by the given CompositeData.
long
getCount()
Returns the number of times that the memory usage has crossed a threshold when the notification was constructed.
getPoolName()
Returns the name of the memory pool that triggers this notification.
getUsage()
Returns the memory usage of the memory pool when this notification was constructed.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
MEMORY_THRESHOLD_EXCEEDED
public static final String MEMORY_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool has reached or exceeded its usage threshold value. This notification is emitted by MemoryMXBean. Subsequent crossing of the usage threshold value does not cause further notification until the memory usage has returned to become less than the usage threshold value. The value of this notification type is java.management.memory.threshold.exceeded.

MEMORY_COLLECTION_THRESHOLD_EXCEEDED
public static final String MEMORY_COLLECTION_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool is greater than or equal to its collection usage threshold after the Java virtual machine has expended effort in recycling unused objects in that memory pool. This notification is emitted by MemoryMXBean. The value of this notification type is java.management.memory.collection.threshold.exceeded.
Constructor Detail
MemoryNotificationInfo
public MemoryNotificationInfo(String poolName,
                              MemoryUsage usage,
                              long count)
Constructs a MemoryNotificationInfo object.
Parameters:
poolName - The name of the memory pool which triggers this notification.
usage - Memory usage of the memory pool.
count - The threshold crossing count.
Method Detail
getPoolName
public String getPoolName()
Returns the name of the memory pool that triggers this notification. The memory pool usage has crossed a threshold.
Returns:
the name of the memory pool that triggers this notification.

getUsage
public MemoryUsage getUsage()
Returns the memory usage of the memory pool when this notification was constructed.
Returns:
the memory usage of the memory pool when this notification was constructed.

getCount
public long getCount()
Returns the number of times that the memory usage has crossed a threshold when the notification was constructed. For usage threshold notifications, this count will be the threshold count. For collection threshold notifications, this count will be the collection usage threshold count.
Returns:
the number of times that the memory usage has crossed a threshold when the notification was constructed.

from
public static MemoryNotificationInfo from(javax.management.openmbean.CompositeData cd)
Returns a MemoryNotificationInfo object represented by the given CompositeData. The given CompositeData must contain the following attributes:
Attribute Name Type
poolName java.lang.String
usage javax.management.openmbean.CompositeData
count java.lang.Long
Parameters:
cd - CompositeData representing a MemoryNotificationInfo
Returns:
a MemoryNotificationInfo object represented by cd if cd is not null; null otherwise.
Throws:
IllegalArgumentException - if cd does not represent a MemoryNotificationInfo object.
Java API documentation generated with DocFlex/Doclet v1.5.6
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc. If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com