KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > monitor > stats > JVMMemoryStats


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 /*
25  * Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
26  * Use is subject to license terms.
27  */
28
29 package com.sun.enterprise.admin.monitor.stats;
30 import javax.management.j2ee.statistics.Stats JavaDoc;
31 import javax.management.j2ee.statistics.CountStatistic JavaDoc;
32
33 /**
34  * A Stats interface, to expose the monitoring information
35  * about the JVM memory subsystem. This interfaces exposes
36  * the memory usage information for the heap and the non-heap
37  * areas of the memory subsystem.
38  * @since 8.1
39  */
40 public interface JVMMemoryStats extends Stats JavaDoc {
41     
42     /**
43      * Returns the approximate number of objects, that are
44      * pending finalization.
45      * @return CountStatistic Objects pending finalization
46      */
47     public CountStatistic JavaDoc getObjectPendingFinalizationCount();
48     
49     /**
50      * Returns the size of the heap initially requested by the JVM
51      * @return CountStatistic initial heap size in bytes
52      */
53     public CountStatistic JavaDoc getInitHeapSize();
54     
55     /**
56      * Returns the size of the heap currently in use
57      * @return CountStatistic current heap usage in bytes
58      */
59     public CountStatistic JavaDoc getUsedHeapSize();
60     
61     /**
62      * Returns the maximum amount of memory in bytes that can be used
63      * for memory management
64      * @return CountStatistic maximum heap size in bytes
65      */
66     public CountStatistic JavaDoc getMaxHeapSize();
67     
68     /**
69      * Returns the amount of memory in bytes that is committed
70      * for the JVM to use
71      * @return CountStatistic memory committed for the jvm in bytes
72      */
73     public CountStatistic JavaDoc getCommittedHeapSize();
74     
75     /**
76      * Returns the size of the non=heap area initially
77      * requested by the JVM
78      * @return CountStatistic initial size of the non-heap area in bytes
79      */
80     public CountStatistic JavaDoc getInitNonHeapSize();
81     
82     /**
83      * Returns the size of the non-heap area currently in use
84      * @return CountStatistic current usage of the non-heap area in bytes
85      */
86     public CountStatistic JavaDoc getUsedNonHeapSize();
87     
88     /**
89      * Returns the maximum amount of memory in bytes that can be used
90      * for memory management
91      * @return CountStatistic maximum non-heap area size in bytes
92      */
93     public CountStatistic JavaDoc getMaxNonHeapSize();
94     
95     /**
96      * Returns the amount of memory in bytes that is committed
97      * for the JVM to use
98      * @return CountStatistic memory committed for the jvm in bytes
99      */
100     public CountStatistic JavaDoc getCommittedNonHeapSize();
101     
102 }
103
Popular Tags