01 /*
02 * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.lang.management;
27
28 /**
29 * The management interface for a memory manager.
30 * A memory manager manages one or more memory pools of the
31 * Java virtual machine.
32 *
33 * <p> A Java virtual machine has one or more memory managers.
34 * An instance implementing this interface is
35 * an <a href="ManagementFactory.html#MXBean">MXBean</a>
36 * that can be obtained by calling
37 * the {@link ManagementFactory#getMemoryManagerMXBeans} method or
38 * from the {@link ManagementFactory#getPlatformMBeanServer
39 * platform <tt>MBeanServer</tt>} method.
40 *
41 * <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
42 * a memory manager within an MBeanServer is:
43 * <blockquote>
44 * {@link ManagementFactory#MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE
45 * <tt>java.lang:type=MemoryManager</tt>}<tt>,name=</tt><i>manager's name</i>
46 * </blockquote>
47 *
48 * @see MemoryMXBean
49 *
50 * @see <a href="../../../javax/management/package-summary.html">
51 * JMX Specification.</a>
52 * @see <a href="package-summary.html#examples">
53 * Ways to Access MXBeans</a>
54 *
55 * @author Mandy Chung
56 * @version 1.17, 05/05/07
57 * @since 1.5
58 */
59 public interface MemoryManagerMXBean {
60 /**
61 * Returns the name representing this memory manager.
62 *
63 * @return the name of this memory manager.
64 */
65 public String getName();
66
67 /**
68 * Tests if this memory manager is valid in the Java virtual
69 * machine. A memory manager becomes invalid once the Java virtual
70 * machine removes it from the memory system.
71 *
72 * @return <tt>true</tt> if the memory manager is valid in the
73 * Java virtual machine;
74 * <tt>false</tt> otherwise.
75 */
76 public boolean isValid();
77
78 /**
79 * Returns the name of memory pools that this memory manager manages.
80 *
81 * @return an array of <tt>String</tt> objects, each is
82 * the name of a memory pool that this memory manager manages.
83 */
84 public String[] getMemoryPoolNames();
85 }
|