19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * 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 * It can be obtained by calling the
49 * {@link PlatformManagedObject#getObjectName} method.
50 *
51 * @see ManagementFactory#getPlatformMXBeans(Class)
52 * @see MemoryMXBean
53 *
54 * @see <a href="../../../javax/management/package-summary.html">
55 * JMX Specification.</a>
56 * @see <a href="package-summary.html#examples">
57 * Ways to Access MXBeans</a>
58 *
59 * @author Mandy Chung
60 * @since 1.5
61 */
62 public interface MemoryManagerMXBean extends PlatformManagedObject {
63 /**
64 * Returns the name representing this memory manager.
65 *
66 * @return the name of this memory manager.
67 */
68 public String getName();
69
70 /**
71 * Tests if this memory manager is valid in the Java virtual
72 * machine. A memory manager becomes invalid once the Java virtual
73 * machine removes it from the memory system.
74 *
75 * @return <tt>true</tt> if the memory manager is valid in the
76 * Java virtual machine;
77 * <tt>false</tt> otherwise.
78 */
79 public boolean isValid();
80
81 /**
82 * Returns the name of memory pools that this memory manager manages.
83 *
84 * @return an array of <tt>String</tt> objects, each is
85 * the name of a memory pool that this memory manager manages.
86 */
87 public String[] getMemoryPoolNames();
88 }
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * 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 MBeanServer} method.
40 *
41 * <p>The {@code ObjectName} 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 * java.lang:type=MemoryManager}{@code ,name=}<i>manager's name</i>
46 * </blockquote>
47 *
48 * It can be obtained by calling the
49 * {@link PlatformManagedObject#getObjectName} method.
50 *
51 * @see ManagementFactory#getPlatformMXBeans(Class)
52 * @see MemoryMXBean
53 *
54 * @see <a href="../../../javax/management/package-summary.html">
55 * JMX Specification.</a>
56 * @see <a href="package-summary.html#examples">
57 * Ways to Access MXBeans</a>
58 *
59 * @author Mandy Chung
60 * @since 1.5
61 */
62 public interface MemoryManagerMXBean extends PlatformManagedObject {
63 /**
64 * Returns the name representing this memory manager.
65 *
66 * @return the name of this memory manager.
67 */
68 public String getName();
69
70 /**
71 * Tests if this memory manager is valid in the Java virtual
72 * machine. A memory manager becomes invalid once the Java virtual
73 * machine removes it from the memory system.
74 *
75 * @return {@code true} if the memory manager is valid in the
76 * Java virtual machine;
77 * {@code false} otherwise.
78 */
79 public boolean isValid();
80
81 /**
82 * Returns the name of memory pools that this memory manager manages.
83 *
84 * @return an array of {@code String} objects, each is
85 * the name of a memory pool that this memory manager manages.
86 */
87 public String[] getMemoryPoolNames();
88 }
|