GarbageCollectorMXBean (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.lang.management
interface GarbageCollectorMXBean

All Superinterfaces:: MemoryManagerMXBean

public interface GarbageCollectorMXBean
extends 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 {@link MemoryManagerMXBean 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 an MXBean that can be obtained by calling the {@link ManagementFactory#getGarbageCollectorMXBeans} method or from the {@link ManagementFactory#getPlatformMBeanServer platform MBeanServer} method.

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

{@link ManagementFactory#GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE java.lang:type=GarbageCollector},name=collector's name

A platform usually includes additional platform-dependent information specific to a garbage collection algorithm for monitoring.

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 class java.lang.management.MemoryManagerMXBean
`getMemoryPoolNames, getName, isValid`

Method Detail

getCollectionCount

public 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

public 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.