| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_262-internal) on Thu Jun 04 16:40:07 GMT 2020 --> |
| <title>MemoryMXBean (OpenJ9 Monitoring and Management Interface Classes)</title> |
| <meta name="date" content="2020-06-04"> |
| <meta name="keywords" content="com.ibm.lang.management.MemoryMXBean interface"> |
| <meta name="keywords" content="getMaxHeapSizeLimit()"> |
| <meta name="keywords" content="getMaxHeapSize()"> |
| <meta name="keywords" content="getMinHeapSize()"> |
| <meta name="keywords" content="setMaxHeapSize()"> |
| <meta name="keywords" content="isSetMaxHeapSizeSupported()"> |
| <meta name="keywords" content="getSharedClassCacheSize()"> |
| <meta name="keywords" content="getSharedClassCacheSoftmxBytes()"> |
| <meta name="keywords" content="getSharedClassCacheMinAotBytes()"> |
| <meta name="keywords" content="getSharedClassCacheMaxAotBytes()"> |
| <meta name="keywords" content="getSharedClassCacheMinJitDataBytes()"> |
| <meta name="keywords" content="getSharedClassCacheMaxJitDataBytes()"> |
| <meta name="keywords" content="setSharedClassCacheSoftmxBytes()"> |
| <meta name="keywords" content="setSharedClassCacheMinAotBytes()"> |
| <meta name="keywords" content="setSharedClassCacheMaxAotBytes()"> |
| <meta name="keywords" content="setSharedClassCacheMinJitDataBytes()"> |
| <meta name="keywords" content="setSharedClassCacheMaxJitDataBytes()"> |
| <meta name="keywords" content="getSharedClassCacheSoftmxUnstoredBytes()"> |
| <meta name="keywords" content="getSharedClassCacheMaxAotUnstoredBytes()"> |
| <meta name="keywords" content="getSharedClassCacheMaxJitDataUnstoredBytes()"> |
| <meta name="keywords" content="getSharedClassCacheFreeSpace()"> |
| <meta name="keywords" content="getGCMode()"> |
| <meta name="keywords" content="getGCMasterThreadCpuUsed()"> |
| <meta name="keywords" content="getGCSlaveThreadsCpuUsed()"> |
| <meta name="keywords" content="getMaximumGCThreads()"> |
| <meta name="keywords" content="getCurrentGCThreads()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MemoryMXBean (OpenJ9 Monitoring and Management Interface Classes)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MemoryMXBean.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/ibm/lang/management/JvmCpuMonitorMXBean.html" title="interface in com.ibm.lang.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/ibm/lang/management/MemoryPoolMXBean.html" title="interface in com.ibm.lang.management"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/lang/management/MemoryMXBean.html" target="_top">Frames</a></li> |
| <li><a href="MemoryMXBean.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.ibm.lang.management</div> |
| <h2 title="Interface MemoryMXBean" class="title">Interface MemoryMXBean</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true" target="_blank" title="class or interface in java.lang.management">MemoryMXBean</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">MemoryMXBean</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true" target="_blank" title="class or interface in java.lang.management">MemoryMXBean</a></pre> |
| <div class="block">The IBM-specific interface for monitoring the virtual machine's memory |
| management system.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getCurrentGCThreads--">getCurrentGCThreads</a></span>()</code> |
| <div class="block">Returns the number of GC worker threads that participated in the most recent collection.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getGCMasterThreadCpuUsed--">getGCMasterThreadCpuUsed</a></span>()</code> |
| <div class="block">Returns the amount of CPU time spent in the GC by the master thread, in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getGCMode--">getGCMode</a></span>()</code> |
| <div class="block">Returns the current GC mode as a human-readable string.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getGCSlaveThreadsCpuUsed--">getGCSlaveThreadsCpuUsed</a></span>()</code> |
| <div class="block">Returns the total amount of CPU time spent in the GC by all slave threads, in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getMaxHeapSize--">getMaxHeapSize</a></span>()</code> |
| <div class="block">Get the current maximum heap size in bytes.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getMaxHeapSizeLimit--">getMaxHeapSizeLimit</a></span>()</code> |
| <div class="block">Get the maximum size in bytes to which the max heap size could be |
| increased in the currently running VM.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getMaximumGCThreads--">getMaximumGCThreads</a></span>()</code> |
| <div class="block">Returns the maximum number of GC worker threads.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getMinHeapSize--">getMinHeapSize</a></span>()</code> |
| <div class="block">Get the minimum heap size in bytes.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheFreeSpace--">getSharedClassCacheFreeSpace</a></span>()</code> |
| <div class="block">Returns the <b>free space</b> in bytes of the cache that the JVM is |
| currently connected to.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheMaxAotBytes--">getSharedClassCacheMaxAotBytes</a></span>()</code> |
| <div class="block">Returns the maximum space allowed for AOT data of the cache that the JVM is currently |
| connected to.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheMaxAotUnstoredBytes--">getSharedClassCacheMaxAotUnstoredBytes</a></span>()</code> |
| <div class="block">Returns the bytes which are not stored into the shared classes cache due to the current setting of maximum space allowed for AOT data.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheMaxJitDataBytes--">getSharedClassCacheMaxJitDataBytes</a></span>()</code> |
| <div class="block">Returns the maximum space allowed for JIT data of the cache that the JVM is currently |
| connected to.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheMaxJitDataUnstoredBytes--">getSharedClassCacheMaxJitDataUnstoredBytes</a></span>()</code> |
| <div class="block">Returns the bytes which are not stored into the shared classes cache due to the current setting of maximum space allowed for JIT data.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheMinAotBytes--">getSharedClassCacheMinAotBytes</a></span>()</code> |
| <div class="block">Returns the minimum space reserved for AOT data of the cache that the JVM is currently |
| connected to.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheMinJitDataBytes--">getSharedClassCacheMinJitDataBytes</a></span>()</code> |
| <div class="block">Returns the minimum space reserved for JIT data of the cache that the JVM is currently |
| connected to.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheSize--">getSharedClassCacheSize</a></span>()</code> |
| <div class="block">Returns the total size in bytes of the cache that the JVM is currently |
| connected to.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheSoftmxBytes--">getSharedClassCacheSoftmxBytes</a></span>()</code> |
| <div class="block">Returns the softmx size in bytes of the cache that the JVM is currently |
| connected to.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#getSharedClassCacheSoftmxUnstoredBytes--">getSharedClassCacheSoftmxUnstoredBytes</a></span>()</code> |
| <div class="block">Returns the bytes which are not stored into the shared classes cache due to the current setting of softmx in shared classes.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#isSetMaxHeapSizeSupported--">isSetMaxHeapSizeSupported</a></span>()</code> |
| <div class="block">Query whether the VM supports runtime reconfiguration of the |
| maximum heap size through the setMaxHeapSize() call.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#setMaxHeapSize-long-">setMaxHeapSize</a></span>(long size)</code> |
| <div class="block">Set the current maximum heap size to <code>size</code>.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#setSharedClassCacheMaxAotBytes-long-">setSharedClassCacheMaxAotBytes</a></span>(long value)</code> |
| <div class="block">Set the maximum shared classes cache space allowed for AOT data to <code>value</code> bytes.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#setSharedClassCacheMaxJitDataBytes-long-">setSharedClassCacheMaxJitDataBytes</a></span>(long value)</code> |
| <div class="block">Set the maximum shared classes cache space allowed for JIT data to <code>value</code> bytes.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#setSharedClassCacheMinAotBytes-long-">setSharedClassCacheMinAotBytes</a></span>(long value)</code> |
| <div class="block">Set the minimum shared classes cache space reserved for AOT data to <code>value</code> bytes.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#setSharedClassCacheMinJitDataBytes-long-">setSharedClassCacheMinJitDataBytes</a></span>(long value)</code> |
| <div class="block">Set the minimum shared classes cache space reserved for JIT data to <code>value</code> bytes.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/MemoryMXBean.html#setSharedClassCacheSoftmxBytes-long-">setSharedClassCacheSoftmxBytes</a></span>(long value)</code> |
| <div class="block">Set the shared class softmx size to <code>value</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.management.MemoryMXBean"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.management.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true" target="_blank" title="class or interface in java.lang.management">MemoryMXBean</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true#gc--" title="class or interface in java.lang.management">gc</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true#getHeapMemoryUsage--" title="class or interface in java.lang.management">getHeapMemoryUsage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true#getNonHeapMemoryUsage--" title="class or interface in java.lang.management">getNonHeapMemoryUsage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true#getObjectPendingFinalizationCount--" title="class or interface in java.lang.management">getObjectPendingFinalizationCount</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true#isVerbose--" title="class or interface in java.lang.management">isVerbose</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryMXBean.html?is-external=true#setVerbose-boolean-" title="class or interface in java.lang.management">setVerbose</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.management.PlatformManagedObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.management.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true#getObjectName--" title="class or interface in java.lang.management">getObjectName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMaxHeapSizeLimit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxHeapSizeLimit</h4> |
| <pre>long getMaxHeapSizeLimit()</pre> |
| <div class="block">Get the maximum size in bytes to which the max heap size could be |
| increased in the currently running VM. This may be larger than the |
| current max heap size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of -Xmx in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxHeapSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxHeapSize</h4> |
| <pre>long getMaxHeapSize()</pre> |
| <div class="block">Get the current maximum heap size in bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current value of -Xsoftmx in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinHeapSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinHeapSize</h4> |
| <pre>long getMinHeapSize()</pre> |
| <div class="block">Get the minimum heap size in bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of -Xms in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxHeapSize-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxHeapSize</h4> |
| <pre>void setMaxHeapSize(long size)</pre> |
| <div class="block">Set the current maximum heap size to <code>size</code>. |
| The parameter specifies the max heap size in bytes and must be |
| between getMinHeapSize() and getMaxHeapSizeLimit(). |
| See -Xsoftmx in the command line reference for additional |
| details on the effect of setting softmx.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - new -Xsoftmx value in bytes</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if this operation is not supported.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input value <code>size</code> is either less than |
| getMinHeapSize() or greater than getMaxHeapSizeLimit().</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - if a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>SecurityManager</code></a> is being used and the caller |
| does not have the <code>ManagementPermission</code> value |
| of "control".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSetMaxHeapSizeSupported--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSetMaxHeapSizeSupported</h4> |
| <pre>boolean isSetMaxHeapSizeSupported()</pre> |
| <div class="block">Query whether the VM supports runtime reconfiguration of the |
| maximum heap size through the setMaxHeapSize() call.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if setMaxHeapSize is supported, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheSize</h4> |
| <pre>long getSharedClassCacheSize()</pre> |
| <div class="block">Returns the total size in bytes of the cache that the JVM is currently |
| connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes in the shared class cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheSoftmxBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheSoftmxBytes</h4> |
| <pre>long getSharedClassCacheSoftmxBytes()</pre> |
| <div class="block">Returns the softmx size in bytes of the cache that the JVM is currently |
| connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the softmx bytes in the shared class cache or cache size if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheMinAotBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheMinAotBytes</h4> |
| <pre>long getSharedClassCacheMinAotBytes()</pre> |
| <div class="block">Returns the minimum space reserved for AOT data of the cache that the JVM is currently |
| connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum shared classes cache space reserved for AOT data in bytes or -1 if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheMaxAotBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheMaxAotBytes</h4> |
| <pre>long getSharedClassCacheMaxAotBytes()</pre> |
| <div class="block">Returns the maximum space allowed for AOT data of the cache that the JVM is currently |
| connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum shared classes cache space allowed for AOT data or -1 if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheMinJitDataBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheMinJitDataBytes</h4> |
| <pre>long getSharedClassCacheMinJitDataBytes()</pre> |
| <div class="block">Returns the minimum space reserved for JIT data of the cache that the JVM is currently |
| connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum shared classes cache space reserved for JIT data or -1 if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheMaxJitDataBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheMaxJitDataBytes</h4> |
| <pre>long getSharedClassCacheMaxJitDataBytes()</pre> |
| <div class="block">Returns the maximum space allowed for JIT data of the cache that the JVM is currently |
| connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum shared classes cache space allowed for JIT data or -1 if it is not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSharedClassCacheSoftmxBytes-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSharedClassCacheSoftmxBytes</h4> |
| <pre>boolean setSharedClassCacheSoftmxBytes(long value)</pre> |
| <div class="block">Set the shared class softmx size to <code>value</code>. |
| The parameter specifies the softmx in bytes. |
| See -Xscmx in the command line reference for additional |
| details on the effect of setting shared class softmx.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - new shared cache soft max value in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the requested operation has been completed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - if a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>SecurityManager</code></a> is being used and the caller |
| does not have the <code>ManagementPermission</code> value |
| of "control".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSharedClassCacheMinAotBytes-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSharedClassCacheMinAotBytes</h4> |
| <pre>boolean setSharedClassCacheMinAotBytes(long value)</pre> |
| <div class="block">Set the minimum shared classes cache space reserved for AOT data to <code>value</code> bytes. |
| See -Xscminaot in the command line reference for additional |
| details on the effect of setting shared class -Xscminaot.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - new -Xscminaot value in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the requested operation has been completed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - if a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>SecurityManager</code></a> is being used and the caller |
| does not have the <code>ManagementPermission</code> value |
| of "control".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSharedClassCacheMaxAotBytes-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSharedClassCacheMaxAotBytes</h4> |
| <pre>boolean setSharedClassCacheMaxAotBytes(long value)</pre> |
| <div class="block">Set the maximum shared classes cache space allowed for AOT data to <code>value</code> bytes. |
| See -Xscmaxaot in the command line reference for additional |
| details on the effect of setting shared class -Xscmaxaot.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - new -Xscmaxaot value in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the requested operation has been completed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - if a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>SecurityManager</code></a> is being used and the caller |
| does not have the <code>ManagementPermission</code> value |
| of "control".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSharedClassCacheMinJitDataBytes-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSharedClassCacheMinJitDataBytes</h4> |
| <pre>boolean setSharedClassCacheMinJitDataBytes(long value)</pre> |
| <div class="block">Set the minimum shared classes cache space reserved for JIT data to <code>value</code> bytes. |
| See -Xscminjitdata in the command line reference for additional |
| details on the effect of setting shared class -Xscminjitdata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - new -Xscminjitdata value in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the requested operation has been completed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - if a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>SecurityManager</code></a> is being used and the caller |
| does not have the <code>ManagementPermission</code> value |
| of "control".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSharedClassCacheMaxJitDataBytes-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSharedClassCacheMaxJitDataBytes</h4> |
| <pre>boolean setSharedClassCacheMaxJitDataBytes(long value)</pre> |
| <div class="block">Set the maximum shared classes cache space allowed for JIT data to <code>value</code> bytes. |
| See -Xscmaxjitdata in the command line reference for additional |
| details on the effect of setting shared class -Xscmaxjitdata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - new -Xscmaxjitdata value in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the requested operation has been completed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - if a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>SecurityManager</code></a> is being used and the caller |
| does not have the <code>ManagementPermission</code> value |
| of "control".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheSoftmxUnstoredBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheSoftmxUnstoredBytes</h4> |
| <pre>long getSharedClassCacheSoftmxUnstoredBytes()</pre> |
| <div class="block">Returns the bytes which are not stored into the shared classes cache due to the current setting of softmx in shared classes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unstored bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheMaxAotUnstoredBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheMaxAotUnstoredBytes</h4> |
| <pre>long getSharedClassCacheMaxAotUnstoredBytes()</pre> |
| <div class="block">Returns the bytes which are not stored into the shared classes cache due to the current setting of maximum space allowed for AOT data.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unstored bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheMaxJitDataUnstoredBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheMaxJitDataUnstoredBytes</h4> |
| <pre>long getSharedClassCacheMaxJitDataUnstoredBytes()</pre> |
| <div class="block">Returns the bytes which are not stored into the shared classes cache due to the current setting of maximum space allowed for JIT data.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unstored bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSharedClassCacheFreeSpace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSharedClassCacheFreeSpace</h4> |
| <pre>long getSharedClassCacheFreeSpace()</pre> |
| <div class="block">Returns the <b>free space</b> in bytes of the cache that the JVM is |
| currently connected to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes free in the shared class cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGCMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGCMode</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getGCMode()</pre> |
| <div class="block">Returns the current GC mode as a human-readable string.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String describing the mode the GC is currently operating in</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGCMasterThreadCpuUsed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGCMasterThreadCpuUsed</h4> |
| <pre>long getGCMasterThreadCpuUsed()</pre> |
| <div class="block">Returns the amount of CPU time spent in the GC by the master thread, in milliseconds.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>CPU time used in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGCSlaveThreadsCpuUsed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGCSlaveThreadsCpuUsed</h4> |
| <pre>long getGCSlaveThreadsCpuUsed()</pre> |
| <div class="block">Returns the total amount of CPU time spent in the GC by all slave threads, in milliseconds.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>CPU time used in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumGCThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumGCThreads</h4> |
| <pre>int getMaximumGCThreads()</pre> |
| <div class="block">Returns the maximum number of GC worker threads.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum number of GC worker threads</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentGCThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCurrentGCThreads</h4> |
| <pre>int getCurrentGCThreads()</pre> |
| <div class="block">Returns the number of GC worker threads that participated in the most recent collection.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of active GC worker threads</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MemoryMXBean.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/ibm/lang/management/JvmCpuMonitorMXBean.html" title="interface in com.ibm.lang.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/ibm/lang/management/MemoryPoolMXBean.html" title="interface in com.ibm.lang.management"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/lang/management/MemoryMXBean.html" target="_top">Frames</a></li> |
| <li><a href="MemoryMXBean.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright © 2001, 2020, IBM Corp. and others.</small></p> |
| </body> |
| </html> |