Interface MemoryManagerMXBean

All Superinterfaces:
PlatformManagedObject
All Known Subinterfaces:
GarbageCollectorMXBean, GarbageCollectorMXBean

public interface MemoryManagerMXBean extends PlatformManagedObject
The management interface for a memory manager. A memory manager manages one or more memory pools of the Java virtual machine.

A Java virtual machine has one or more memory managers. An instance implementing this interface is an MXBean that can be obtained by calling the ManagementFactory.getMemoryManagerMXBeans() method or from the platform MBeanServer method.

The ObjectName for uniquely identifying the MXBean for a memory manager within an MBeanServer is:

java.lang:type=MemoryManager,name=manager's name
It can be obtained by calling the PlatformManagedObject.getObjectName() method.
Since:
1.5
See Also:
ManagementFactory.getPlatformMXBeans(Class), MemoryMXBean, JMX Specification., Ways to Access MXBeans
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the name of memory pools that this memory manager manages.
    Returns the name representing this memory manager.
    boolean
    Tests if this memory manager is valid in the Java virtual machine.

    Methods declared in interface java.lang.management.PlatformManagedObject

    getObjectName
  • Method Details

    • getName

      String getName()
      Returns the name representing this memory manager.
      Returns:
      the name of this memory manager.
    • isValid

      boolean isValid()
      Tests if this memory manager is valid in the Java virtual machine. A memory manager becomes invalid once the Java virtual machine removes it from the memory system.
      Returns:
      true if the memory manager is valid in the Java virtual machine; false otherwise.
    • getMemoryPoolNames

      String[] getMemoryPoolNames()
      Returns the name of memory pools that this memory manager manages.
      Returns:
      an array of String objects, each is the name of a memory pool that this memory manager manages.