java.lang.management
Interface GarbageCollectorMXBean

All Superinterfaces:
MemoryManagerMXBean

public interface GarbageCollectorMXBean
extends MemoryManagerMXBean

Provides access to information about the garbage collectors of the virtual machine. Garbage collectors are responsible for removing unreferenced objects from memory. A garbage collector is a type of memory manager, so this interface is combined with that of generic memory managers. An instance of this bean for each garbage collector is obtained by calling ManagementFactory.getGarbageCollectorMXBeans().

Since:
1.5

Method Summary
 long getCollectionCount()
          Returns the number of collections the garbage collector represented by this bean has made
 long getCollectionTime()
          Returns the accumulated number of milliseconds this garbage collector has spent freeing the memory used by unreferenced objects
 
Methods inherited from interface java.lang.management.MemoryManagerMXBean
getMemoryPoolNames, getName, isValid
 

Method Detail

getCollectionCount

long getCollectionCount()
Returns the number of collections the garbage collector represented by this bean has made. -1 is returned if the collection count is undefined.

Returns:
the number of collections made, or -1 if this is undefined.

getCollectionTime

long getCollectionTime()
Returns the accumulated number of milliseconds this garbage collector has spent freeing the memory used by unreferenced objects. -1 is returned if the collection time is undefined. Note that the accumulated time may not change, even when the collection count increases, if the time taken is sufficiently short; this depends on the resolution of the timer used.

Returns:
the accumulated number of milliseconds spent collecting, or -1 if this is undefined.