/*
* @(#)MemoryManagerMXBean.java 1.11 05/11/17
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package java.lang.management;
/**
* The management interface for a memory manager.
* A memory manager manages one or more memory pools of the
* Java virtual machine.
*
* <p> A Java virtual machine has one or more memory managers.
* An instance implementing this interface is
* an <a href="ManagementFactory.html#MXBean">MXBean</a>
* that can be obtained by calling
* the {@link ManagementFactory#getMemoryManagerMXBeans} method or
* from the {@link ManagementFactory#getPlatformMBeanServer
* platform <tt>MBeanServer</tt>} method.
*
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
* a memory manager within an MBeanServer is:
* <blockquote>
* {@link ManagementFactory#MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE
* <tt>java.lang:type=MemoryManager</tt>}<tt>,name=</tt><i>manager's name</i>
* </blockquote>
*
* @see MemoryMXBean
*
* @see <a href="../../../javax/management/package-summary.html">
* JMX Specification.</a>
* @see <a href="package-summary.html#examples">
* Ways to Access MXBeans</a>
*
* @author Mandy Chung
* @version 1.11, 11/17/05
* @since 1.5
*/
public interface MemoryManagerMXBean {
/**
* Returns the name representing this memory manager.
*
* @return the name of this memory manager.
*/
public String getName();
/**
* 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.
*
* @return <tt>true</tt> if the memory manager is valid in the
* Java virtual machine;
* <tt>false</tt> otherwise.
*/
public boolean isValid();
/**
* Returns the name of memory pools that this memory manager manages.
*
* @return an array of <tt>String</tt> objects, each is
* the name of a memory pool that this memory manager manages.
*/
public String[] getMemoryPoolNames();
}