-
- All Superinterfaces:
- MemoryManagerMXBean, PlatformManagedObject
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 ofmemory 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
ManagementFactory.getGarbageCollectorMXBeans()method or from theplatform MBeanServermethod.The ObjectName for uniquely identifying the MXBean for a garbage collector within an MBeanServer is:
It can be obtained by calling thejava.lang:type=GarbageCollector,name=collector's namePlatformManagedObject.getObjectName()method. A platform usually includes additional platform-dependent information specific to a garbage collection algorithm for monitoring.- Since:
- 1.5
- See Also:
ManagementFactory.getPlatformMXBeans(Class),MemoryMXBean, JMX Specification., Ways to Access MXBeans
-
-
Method Summary
Methods Modifier and Type Method and Description longgetCollectionCount()Returns the total number of collections that have occurred.longgetCollectionTime()Returns the approximate accumulated collection elapsed time in milliseconds.-
Methods inherited from interface java.lang.management.MemoryManagerMXBean
getMemoryPoolNames, getName, isValid
-
Methods inherited from interface java.lang.management.PlatformManagedObject
getObjectName
-
-
-
-
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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/lang/management/garbagecollectormxbean.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
