author | ksrini |
Mon, 01 May 2017 07:33:19 -0700 | |
changeset 44858 | 7183899b064b |
parent 32034 | 05676cfd40b5 |
child 47028 | 6df65183aa1f |
permissions | -rw-r--r-- |
2 | 1 |
/* |
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
2 |
* Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 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. |
|
2 | 24 |
*/ |
25 |
||
26 |
package java.lang.management; |
|
27 |
||
28 |
import javax.management.openmbean.CompositeData; |
|
29 |
import sun.management.MemoryUsageCompositeData; |
|
30 |
||
31 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
32 |
* A {@code MemoryUsage} object represents a snapshot of memory usage. |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
33 |
* Instances of the {@code MemoryUsage} class are usually constructed |
2 | 34 |
* by methods that are used to obtain memory usage |
35 |
* information about individual memory pool of the Java virtual machine or |
|
36 |
* the heap or non-heap memory of the Java virtual machine as a whole. |
|
37 |
* |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
38 |
* <p> A {@code MemoryUsage} object contains four values: |
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
39 |
* <table> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
40 |
* <caption style="display:none">Describes the MemoryUsage object content</caption> |
2 | 41 |
* <tr> |
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
42 |
* <td style="vertical-align:top"> {@code init} </td> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
43 |
* <td style="vertical-align:top"> represents the initial amount of memory (in bytes) that |
2 | 44 |
* the Java virtual machine requests from the operating system |
45 |
* for memory management during startup. The Java virtual machine |
|
46 |
* may request additional memory from the operating system and |
|
47 |
* may also release memory to the system over time. |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
48 |
* The value of {@code init} may be undefined. |
2 | 49 |
* </td> |
50 |
* </tr> |
|
51 |
* <tr> |
|
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
52 |
* <td style="vertical-align:top"> {@code used} </td> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
53 |
* <td style="vertical-align:top"> represents the amount of memory currently used (in bytes). |
2 | 54 |
* </td> |
55 |
* </tr> |
|
56 |
* <tr> |
|
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
57 |
* <td style="vertical-align:top"> {@code committed} </td> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
58 |
* <td style="vertical-align:top"> represents the amount of memory (in bytes) that is |
2 | 59 |
* guaranteed to be available for use by the Java virtual machine. |
60 |
* The amount of committed memory may change over time (increase |
|
61 |
* or decrease). The Java virtual machine may release memory to |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
62 |
* the system and {@code committed} could be less than {@code init}. |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
63 |
* {@code committed} will always be greater than |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
64 |
* or equal to {@code used}. |
2 | 65 |
* </td> |
66 |
* </tr> |
|
67 |
* <tr> |
|
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
68 |
* <td style="vertical-align:top"> {@code max} </td> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
69 |
* <td style="vertical-align:top"> represents the maximum amount of memory (in bytes) |
2 | 70 |
* that can be used for memory management. Its value may be undefined. |
71 |
* The maximum amount of memory may change over time if defined. |
|
72 |
* The amount of used and committed memory will always be less than |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
73 |
* or equal to {@code max} if {@code max} is defined. |
2 | 74 |
* A memory allocation may fail if it attempts to increase the |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
75 |
* used memory such that {@code used > committed} even |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
76 |
* if {@code used <= max} would still be true (for example, |
2 | 77 |
* when the system is low on virtual memory). |
78 |
* </td> |
|
79 |
* </tr> |
|
80 |
* </table> |
|
81 |
* |
|
82 |
* Below is a picture showing an example of a memory pool: |
|
21334 | 83 |
* |
2 | 84 |
* <pre> |
85 |
* +----------------------------------------------+ |
|
86 |
* +//////////////// | + |
|
87 |
* +//////////////// | + |
|
88 |
* +----------------------------------------------+ |
|
89 |
* |
|
90 |
* |--------| |
|
91 |
* init |
|
92 |
* |---------------| |
|
93 |
* used |
|
94 |
* |---------------------------| |
|
95 |
* committed |
|
96 |
* |----------------------------------------------| |
|
97 |
* max |
|
98 |
* </pre> |
|
99 |
* |
|
18799
31062cb3cc8e
8020308: Fix doclint issues in java.lang.management
sspitsyn
parents:
18156
diff
changeset
|
100 |
* <h3>MXBean Mapping</h3> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
101 |
* {@code MemoryUsage} is mapped to a {@link CompositeData CompositeData} |
2 | 102 |
* with attributes as specified in the {@link #from from} method. |
103 |
* |
|
104 |
* @author Mandy Chung |
|
105 |
* @since 1.5 |
|
106 |
*/ |
|
107 |
public class MemoryUsage { |
|
108 |
private final long init; |
|
109 |
private final long used; |
|
110 |
private final long committed; |
|
111 |
private final long max; |
|
112 |
||
113 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
114 |
* Constructs a {@code MemoryUsage} object. |
2 | 115 |
* |
116 |
* @param init the initial amount of memory in bytes that |
|
117 |
* the Java virtual machine allocates; |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
118 |
* or {@code -1} if undefined. |
2 | 119 |
* @param used the amount of used memory in bytes. |
120 |
* @param committed the amount of committed memory in bytes. |
|
121 |
* @param max the maximum amount of memory in bytes that |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
122 |
* can be used; or {@code -1} if undefined. |
2 | 123 |
* |
124 |
* @throws IllegalArgumentException if |
|
125 |
* <ul> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
126 |
* <li> the value of {@code init} or {@code max} is negative |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
127 |
* but not {@code -1}; or</li> |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
128 |
* <li> the value of {@code used} or {@code committed} is negative; |
2 | 129 |
* or</li> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
130 |
* <li> {@code used} is greater than the value of {@code committed}; |
2 | 131 |
* or</li> |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
132 |
* <li> {@code committed} is greater than the value of {@code max} |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
133 |
* {@code max} if defined.</li> |
2 | 134 |
* </ul> |
135 |
*/ |
|
136 |
public MemoryUsage(long init, |
|
137 |
long used, |
|
138 |
long committed, |
|
139 |
long max) { |
|
140 |
if (init < -1) { |
|
141 |
throw new IllegalArgumentException( "init parameter = " + |
|
142 |
init + " is negative but not -1."); |
|
143 |
} |
|
144 |
if (max < -1) { |
|
145 |
throw new IllegalArgumentException( "max parameter = " + |
|
146 |
max + " is negative but not -1."); |
|
147 |
} |
|
148 |
if (used < 0) { |
|
149 |
throw new IllegalArgumentException( "used parameter = " + |
|
150 |
used + " is negative."); |
|
151 |
} |
|
152 |
if (committed < 0) { |
|
153 |
throw new IllegalArgumentException( "committed parameter = " + |
|
154 |
committed + " is negative."); |
|
155 |
} |
|
156 |
if (used > committed) { |
|
157 |
throw new IllegalArgumentException( "used = " + used + |
|
158 |
" should be <= committed = " + committed); |
|
159 |
} |
|
160 |
if (max >= 0 && committed > max) { |
|
161 |
throw new IllegalArgumentException( "committed = " + committed + |
|
162 |
" should be < max = " + max); |
|
163 |
} |
|
164 |
||
165 |
this.init = init; |
|
166 |
this.used = used; |
|
167 |
this.committed = committed; |
|
168 |
this.max = max; |
|
169 |
} |
|
170 |
||
171 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
172 |
* Constructs a {@code MemoryUsage} object from a |
2 | 173 |
* {@link CompositeData CompositeData}. |
174 |
*/ |
|
175 |
private MemoryUsage(CompositeData cd) { |
|
176 |
// validate the input composite data |
|
177 |
MemoryUsageCompositeData.validateCompositeData(cd); |
|
178 |
||
179 |
this.init = MemoryUsageCompositeData.getInit(cd); |
|
180 |
this.used = MemoryUsageCompositeData.getUsed(cd); |
|
181 |
this.committed = MemoryUsageCompositeData.getCommitted(cd); |
|
182 |
this.max = MemoryUsageCompositeData.getMax(cd); |
|
183 |
} |
|
184 |
||
185 |
/** |
|
186 |
* Returns the amount of memory in bytes that the Java virtual machine |
|
187 |
* initially requests from the operating system for memory management. |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
188 |
* This method returns {@code -1} if the initial memory size is undefined. |
2 | 189 |
* |
190 |
* @return the initial size of memory in bytes; |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
191 |
* {@code -1} if undefined. |
2 | 192 |
*/ |
193 |
public long getInit() { |
|
194 |
return init; |
|
195 |
} |
|
196 |
||
197 |
/** |
|
198 |
* Returns the amount of used memory in bytes. |
|
199 |
* |
|
200 |
* @return the amount of used memory in bytes. |
|
201 |
* |
|
202 |
*/ |
|
203 |
public long getUsed() { |
|
204 |
return used; |
|
205 |
}; |
|
206 |
||
207 |
/** |
|
208 |
* Returns the amount of memory in bytes that is committed for |
|
209 |
* the Java virtual machine to use. This amount of memory is |
|
210 |
* guaranteed for the Java virtual machine to use. |
|
211 |
* |
|
212 |
* @return the amount of committed memory in bytes. |
|
213 |
* |
|
214 |
*/ |
|
215 |
public long getCommitted() { |
|
216 |
return committed; |
|
217 |
}; |
|
218 |
||
219 |
/** |
|
220 |
* Returns the maximum amount of memory in bytes that can be |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
221 |
* used for memory management. This method returns {@code -1} |
2 | 222 |
* if the maximum memory size is undefined. |
223 |
* |
|
224 |
* <p> This amount of memory is not guaranteed to be available |
|
225 |
* for memory management if it is greater than the amount of |
|
226 |
* committed memory. The Java virtual machine may fail to allocate |
|
227 |
* memory even if the amount of used memory does not exceed this |
|
228 |
* maximum size. |
|
229 |
* |
|
230 |
* @return the maximum amount of memory in bytes; |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
231 |
* {@code -1} if undefined. |
2 | 232 |
*/ |
233 |
public long getMax() { |
|
234 |
return max; |
|
235 |
}; |
|
236 |
||
237 |
/** |
|
238 |
* Returns a descriptive representation of this memory usage. |
|
239 |
*/ |
|
240 |
public String toString() { |
|
22581
e868cde95050
8032779: Update code in java.lang to use newer language features
psandoz
parents:
21334
diff
changeset
|
241 |
StringBuilder buf = new StringBuilder(); |
2 | 242 |
buf.append("init = " + init + "(" + (init >> 10) + "K) "); |
243 |
buf.append("used = " + used + "(" + (used >> 10) + "K) "); |
|
244 |
buf.append("committed = " + committed + "(" + |
|
245 |
(committed >> 10) + "K) " ); |
|
246 |
buf.append("max = " + max + "(" + (max >> 10) + "K)"); |
|
247 |
return buf.toString(); |
|
248 |
} |
|
249 |
||
250 |
/** |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
251 |
* Returns a {@code MemoryUsage} object represented by the |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
252 |
* given {@code CompositeData}. The given {@code CompositeData} |
2 | 253 |
* must contain the following attributes: |
21334 | 254 |
* |
2 | 255 |
* <blockquote> |
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
256 |
* <table border="1"> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
257 |
* <caption style="display:none">The attributes and the types the given CompositeData contains</caption> |
2 | 258 |
* <tr> |
44858
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
259 |
* <th style="text-align:left">Attribute Name</th> |
7183899b064b
8179415: Update java.management and java.management.rmi to be HTML-5 friendly
ksrini
parents:
32034
diff
changeset
|
260 |
* <th style="text-align:left">Type</th> |
2 | 261 |
* </tr> |
262 |
* <tr> |
|
263 |
* <td>init</td> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
264 |
* <td>{@code java.lang.Long}</td> |
2 | 265 |
* </tr> |
266 |
* <tr> |
|
267 |
* <td>used</td> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
268 |
* <td>{@code java.lang.Long}</td> |
2 | 269 |
* </tr> |
270 |
* <tr> |
|
271 |
* <td>committed</td> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
272 |
* <td>{@code java.lang.Long}</td> |
2 | 273 |
* </tr> |
274 |
* <tr> |
|
275 |
* <td>max</td> |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
276 |
* <td>{@code java.lang.Long}</td> |
2 | 277 |
* </tr> |
278 |
* </table> |
|
279 |
* </blockquote> |
|
280 |
* |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
281 |
* @param cd {@code CompositeData} representing a {@code MemoryUsage} |
2 | 282 |
* |
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
283 |
* @throws IllegalArgumentException if {@code cd} does not |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
284 |
* represent a {@code MemoryUsage} with the attributes described |
2 | 285 |
* above. |
286 |
* |
|
32034
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
287 |
* @return a {@code MemoryUsage} object represented by {@code cd} |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
288 |
* if {@code cd} is not {@code null}; |
05676cfd40b5
8133040: docs: replace <tt> tags (obsolete in html5) for java.management
avstepan
parents:
25859
diff
changeset
|
289 |
* {@code null} otherwise. |
2 | 290 |
*/ |
291 |
public static MemoryUsage from(CompositeData cd) { |
|
292 |
if (cd == null) { |
|
293 |
return null; |
|
294 |
} |
|
295 |
||
296 |
if (cd instanceof MemoryUsageCompositeData) { |
|
297 |
return ((MemoryUsageCompositeData) cd).getMemoryUsage(); |
|
298 |
} else { |
|
299 |
return new MemoryUsage(cd); |
|
300 |
} |
|
301 |
||
302 |
} |
|
303 |
} |