gnu.java.lang.management

Class MemoryMXBeanImpl

Implemented Interfaces:
DynamicMBean, MemoryMXBean, NotificationBroadcaster, NotificationEmitter

public final class MemoryMXBeanImpl
extends BeanImpl
implements MemoryMXBean, NotificationEmitter

Provides access to information about the memory management of the current invocation of the virtual machine. Instances of this bean are obtained by calling ManagementFactory.getMemoryMXBean().
Since:
1.5

Field Summary

static CompositeType
notifType
static CompositeType
usageType

Constructor Summary

MemoryMXBeanImpl()
Constructs a new MemoryMXBeanImpl.

Method Summary

void
addNotificationListener(NotificationListener listener, NotificationFilter filter, Object passback)
Registers the specified listener as a new recipient of notifications from this bean.
void
gc()
Instigates a garbage collection cycle.
MemoryUsage
getHeapMemoryUsage()
Returns a MemoryUsage object representing the current state of the heap.
MemoryUsage
getNonHeapMemoryUsage()
Returns a MemoryUsage object representing the current state of non-heap memory.
MBeanNotificationInfo[]
getNotificationInfo()
Returns an array describing the notifications this bean may send to its registered listeners.
int
getObjectPendingFinalizationCount()
Returns the number of objects which are waiting to be garbage collected (finalized).
boolean
isVerbose()
Returns true if the virtual machine will emit additional information when memory is allocated and deallocated.
void
removeNotificationListener(NotificationListener listener)
Removes the specified listener from the list of recipients of notifications from this bean.
void
removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object passback)
Removes the specified listener from the list of recipients of notifications from this bean.
void
setVerbose(boolean verbose)
Turns on or off the emission of additional information when memory is allocated and deallocated.

Methods inherited from class gnu.java.lang.management.BeanImpl

cacheMBeanInfo, checkControlPermissions, checkMonitorPermissions, getAttribute, getCachedMBeanInfo, getDescription, getDescription, getMBeanInfo, getParameterName, getParameterName

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

notifType

public static CompositeType notifType

usageType

public static CompositeType usageType

Constructor Details

MemoryMXBeanImpl

public MemoryMXBeanImpl()
            throws NotCompliantMBeanException
Constructs a new MemoryMXBeanImpl.
Throws:
NotCompliantMBeanException - if this class doesn't implement the interface or a method appears in the interface that doesn't comply with the naming conventions.

Method Details

addNotificationListener

public void addNotificationListener(NotificationListener listener,
                                    NotificationFilter filter,
                                    Object passback)
Registers the specified listener as a new recipient of notifications from this bean. If non-null, the filter argument will be used to select which notifications are delivered. The supplied object will also be passed to the recipient with each notification. This should not be modified by the broadcaster, but instead should be passed unmodified to the listener.
Specified by:
addNotificationListener in interface NotificationBroadcaster
Parameters:
listener - the new listener, who will receive notifications from this broadcasting bean.
filter - a filter to determine which notifications are delivered to the listener, or null if no filtering is required.
passback - an object to be passed to the listener with each notification.
Throws:
IllegalArgumentException - if listener is null.

gc

public void gc()
Instigates a garbage collection cycle. The virtual machine's garbage collector should make the best attempt it can at reclaiming unused memory. This is equivalent to invoking java.lang.System.gc().
Specified by:
gc in interface MemoryMXBean
See Also:
System.gc()

getHeapMemoryUsage

public MemoryUsage getHeapMemoryUsage()
Returns a MemoryUsage object representing the current state of the heap. This incorporates various statistics on both the initial and current memory allocations used by the heap.
Specified by:
getHeapMemoryUsage in interface MemoryMXBean
Returns:
a MemoryUsage object for the heap.

getNonHeapMemoryUsage

public MemoryUsage getNonHeapMemoryUsage()
Returns a MemoryUsage object representing the current state of non-heap memory. This incorporates various statistics on both the initial and current memory allocations used by non-heap memory..
Specified by:
getNonHeapMemoryUsage in interface MemoryMXBean
Returns:
a MemoryUsage object for non-heap memory.

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()
Returns an array describing the notifications this bean may send to its registered listeners. Ideally, this array should be complete, but in some cases, this may not be possible. However, be aware that some listeners may expect this to be so.
Specified by:
getNotificationInfo in interface NotificationBroadcaster
Returns:
the array of possible notifications.

getObjectPendingFinalizationCount

public int getObjectPendingFinalizationCount()
Returns the number of objects which are waiting to be garbage collected (finalized). An object is finalized when the garbage collector determines that there are no more references to that object are in use.
Specified by:
getObjectPendingFinalizationCount in interface MemoryMXBean
Returns:
the number of objects awaiting finalization.

isVerbose

public boolean isVerbose()
Returns true if the virtual machine will emit additional information when memory is allocated and deallocated. The format of the output is left up to the virtual machine.
Specified by:
isVerbose in interface MemoryMXBean
Returns:
true if verbose memory output is on.

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
            throws ListenerNotFoundException
Removes the specified listener from the list of recipients of notifications from this bean. This includes all combinations of filters and passback objects registered for this listener. For more specific removal of listeners, see the subinterface NotificationEmitter.
Specified by:
removeNotificationListener in interface NotificationBroadcaster
Parameters:
listener - the listener to remove.
Throws:
ListenerNotFoundException - if the specified listener is not registered with this bean.

removeNotificationListener

public void removeNotificationListener(NotificationListener listener,
                                       NotificationFilter filter,
                                       Object passback)
            throws ListenerNotFoundException
Removes the specified listener from the list of recipients of notifications from this bean. Only the first instance with the supplied filter and passback object is removed. null is used as a valid value for these parameters, rather than as a way to remove all registration instances for the specified listener; for this behaviour instead, see the details of the same method in NotificationBroadcaster.
Specified by:
removeNotificationListener in interface NotificationEmitter
Parameters:
listener - the listener to remove.
filter - the filter of the listener to remove.
passback - the passback object of the listener to remove.
Throws:
ListenerNotFoundException - if the specified listener is not registered with this bean.
See Also:
addNotificationListener(NotificationListener, NotificationFilter, java.lang.Object)

setVerbose

public void setVerbose(boolean verbose)
Turns on or off the emission of additional information when memory is allocated and deallocated. The format of the output is left up to the virtual machine. This method may be called by multiple threads concurrently, but there is only one global setting of verbosity that is affected.
Specified by:
setVerbose in interface MemoryMXBean
Parameters:
verbose - the new setting for verbose memory output.
Throws:
SecurityException - if a security manager exists and denies ManagementPermission("control").

MemoryMXBeanImpl.java - Implementation of a memory bean Copyright (C) 2006 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.