java.lang.management
Interface GarbageCollectorMXBean

All Superinterfaces:
MemoryManagerMXBean sample code for java.lang.management.MemoryManagerMXBean definition code for java.lang.management.MemoryManagerMXBean

public interface GarbageCollectorMXBean
extends MemoryManagerMXBean sample code for java.lang.management.MemoryManagerMXBean definition code for java.lang.management.MemoryManagerMXBean

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 sample code for java.lang.management.MemoryManagerMXBean definition code for java.lang.management.MemoryManagerMXBean .

A Java virtual machine may have one or more instances of the implementation class of this interface. An instance implementing this interface is an MXBean that can be obtained by calling the ManagementFactory.getGarbageCollectorMXBeans() sample code for java.lang.management.ManagementFactory.getGarbageCollectorMXBeans() definition code for java.lang.management.ManagementFactory.getGarbageCollectorMXBeans() method or from the platform MBeanServer sample code for java.lang.management.ManagementFactory.getPlatformMBeanServer() definition code for java.lang.management.ManagementFactory.getPlatformMBeanServer() method.

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

java.lang:type=GarbageCollector sample code for java.lang.management.ManagementFactory.GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE definition code for java.lang.management.ManagementFactory.GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE ,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:
MemoryMXBean sample code for java.lang.management.MemoryMXBean definition code for java.lang.management.MemoryMXBean , JMX Specification., Ways to Access MXBeans

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

Method Detail

getCollectionCount sample code for java.lang.management.GarbageCollectorMXBean.getCollectionCount() definition code for java.lang.management.GarbageCollectorMXBean.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 sample code for java.lang.management.GarbageCollectorMXBean.getCollectionTime() definition code for java.lang.management.GarbageCollectorMXBean.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.