1 /*
2  * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle 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 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  * Types of {@link MemoryPoolMXBean memory pools}.
30  *
31  * @author  Mandy Chung
32  * @since   1.5
33  */
34 public enum MemoryType {
35
36     /**
37      * Heap memory type.
38      * <p>
39      * The Java virtual machine has a <i>heap</i>
40      * that is the runtime data area from which
41      * memory for all class instances and arrays are allocated.
42      */
43     HEAP("Heap memory"),
44
45     /**
46      * Non-heap memory type.
47      * <p>
48      * The Java virtual machine manages memory other than the heap
49      * (referred as <i>non-heap memory</i>).  The non-heap memory includes
50      * the <i>method area</i> and memory required for the internal
51      * processing or optimization for the Java virtual machine.
52      * It stores per-class structures such as a runtime
53      * constant pool, field and method data, and the code for
54      * methods and constructors.
55      */
56     NON_HEAP("Non-heap memory");
57
58     private final String description;
59
60     private MemoryType(String s) {
61         this.description = s;
62     }
63
64     /**
65      * Returns the string representation of this {@code MemoryType}.
66      * @return the string representation of this {@code MemoryType}.
67      */
68     public String toString() {
69         return description;
70     }
71
72     private static final long serialVersionUID = 6992337162326171013L;
73 }
74