java.lang.management
Interface GarbageCollectorMBean

All Superinterfaces:
MemoryManagerMBean

public interface GarbageCollectorMBean
extends MemoryManagerMBean

The management interface for the garbage collection of the Java virtual machine. Garbage collection is the process that the Java virtual machine uses to find and reclaim unreachable objects to free up memory space. A garbage collector is one type of memory manager.

A Java virtual machine may have one or more instances of the implementation class of this interface. An instance implementing this interface is a managed bean (MBean) conforming to the JMX Instrumentation Specification. The MBeans can be obtained by calling the ManagementFactory.getGarbageCollectorMBeans() method. An application can monitor the instrumentation of the garbage collection and manage certain characteristics in any of the following ways:

The ManagementFactory.getPlatformMBeanServer() method returns the platform MBeanServer registered with all platform MBeans.

The ObjectName for uniquely identifying the MBean for a garbage collector within an MBeanServer is:

java.lang:type=GarbageCollector,name=collector's name
A platform usually includes additional platform-dependent information specific to a garbage collection algorithm for monitoring.

Since:
1.5
See Also:
MemoryMBean, Ways to Access Management Metrics

Method Summary
 long getCollectionCount()
          Returns the total number of collections that have occurred.
 long getCollectionTime()
          Returns the approximate accumulated collection elapsed time in milliseconds.
 
Methods inherited from interface java.lang.management.MemoryManagerMBean
getMemoryPoolNames, getName, isValid
 

Method Detail

getCollectionCount

long getCollectionCount()
Returns the total number of collections that have occurred. This method returns -1 if the collection count is undefined for this collector.

Returns:
the total number of collections that have occurred.

getCollectionTime

long getCollectionTime()
Returns the approximate accumulated collection elapsed time in milliseconds. This method returns -1 if the collection elapsed time is undefined for this collector.

The Java virtual machine implementation may use a high resolution timer to measure the elapsed time. This method may return the same value even if the collection count has been incremented if the collection elapsed time is very short.

Returns:
the approximate accumulated collection elapsed time in milliseconds.