api/jdk16/jdk.management/com/ibm/lang/management/MemoryMXBean.html - gerrit/www.eclipse.org/openj9/docs - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (16) -->
 <title>MemoryMXBean (OpenJ9 JDK 16)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: module: jdk.management, package: com.ibm.lang.management, interface: MemoryMXBean">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <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="getGCMainThreadCpuUsed()">
 <meta name="keywords" content="getGCWorkerThreadsCpuUsed()">
 <meta name="keywords" content="getMaximumGCThreads()">
 <meta name="keywords" content="getCurrentGCThreads()">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar.top">
 <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div>
 <ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="../../../../module-summary.html">Module</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">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-files/index-1.html">Index</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip.navbar.top">
 <!--   -->
 </span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">jdk.management</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.lang.management</a></div>
 <h1 title="Interface MemoryMXBean" class="title">Interface MemoryMXBean</h1>
 </div>
 <section class="description">
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryMXBean</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html" title="class or interface in java.lang.management" class="external-link" target="_blank">PlatformManagedObject</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="internal/ExtendedMemoryMXBeanImpl.html" title="class in com.ibm.lang.management.internal">ExtendedMemoryMXBeanImpl</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MemoryMXBean</span><span class="extends-implements">
 extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryMXBean</a></span></div>
 <div class="block">The OpenJ9 extension interface for monitoring the virtual machine's memory
  management system.</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.5</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method.summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getCurrentGCThreads()">getCurrentGCThreads</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the number of GC worker threads that participated in the most recent collection.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getGCMainThreadCpuUsed()">getGCMainThreadCpuUsed</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the amount of CPU time spent in the GC by the main thread, in
  milliseconds.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getGCMode()">getGCMode</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the current GC mode as a human-readable string.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getGCWorkerThreadsCpuUsed()">getGCWorkerThreadsCpuUsed</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the total amount of CPU time spent in the GC by all worker threads,
  in milliseconds.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getMaxHeapSize()">getMaxHeapSize</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Get the current maximum heap size in bytes.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getMaxHeapSizeLimit()">getMaxHeapSizeLimit</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Get the maximum size in bytes to which the max heap size could be
  increased in the currently running VM.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getMaximumGCThreads()">getMaximumGCThreads</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the maximum number of GC worker threads.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getMinHeapSize()">getMinHeapSize</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Get the minimum heap size in bytes.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheFreeSpace()">getSharedClassCacheFreeSpace</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the <b>free space</b> in bytes of the cache that the JVM is
  currently connected to.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheMaxAotBytes()">getSharedClassCacheMaxAotBytes</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the maximum space allowed for AOT data of the cache that the JVM is currently
  connected to.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheMaxAotUnstoredBytes()">getSharedClassCacheMaxAotUnstoredBytes</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <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>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheMaxJitDataBytes()">getSharedClassCacheMaxJitDataBytes</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the maximum space allowed for JIT data of the cache that the JVM is currently
  connected to.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheMaxJitDataUnstoredBytes()">getSharedClassCacheMaxJitDataUnstoredBytes</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <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>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheMinAotBytes()">getSharedClassCacheMinAotBytes</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the minimum space reserved for AOT data of the cache that the JVM is currently
  connected to.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheMinJitDataBytes()">getSharedClassCacheMinJitDataBytes</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the minimum space reserved for JIT data of the cache that the JVM is currently
  connected to.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheSize()">getSharedClassCacheSize</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the total size in bytes of the cache that the JVM is currently
  connected to.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheSoftmxBytes()">getSharedClassCacheSoftmxBytes</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Returns the softmx size in bytes of the cache that the JVM is currently
  connected to.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>long</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSharedClassCacheSoftmxUnstoredBytes()">getSharedClassCacheSoftmxUnstoredBytes</a></span>()</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <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>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isSetMaxHeapSizeSupported()">isSetMaxHeapSizeSupported</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Query whether the VM supports runtime reconfiguration of the
  maximum heap size through the setMaxHeapSize() call.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setMaxHeapSize(long)">setMaxHeapSize</a></span>&#8203;(long&nbsp;size)</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Set the current maximum heap size to <code>size</code>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setSharedClassCacheMaxAotBytes(long)">setSharedClassCacheMaxAotBytes</a></span>&#8203;(long&nbsp;value)</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Set the maximum shared classes cache space allowed for AOT data to <code>value</code> bytes.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setSharedClassCacheMaxJitDataBytes(long)">setSharedClassCacheMaxJitDataBytes</a></span>&#8203;(long&nbsp;value)</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Set the maximum shared classes cache space allowed for JIT data to <code>value</code> bytes.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setSharedClassCacheMinAotBytes(long)">setSharedClassCacheMinAotBytes</a></span>&#8203;(long&nbsp;value)</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Set the minimum shared classes cache space reserved for AOT data to <code>value</code> bytes.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setSharedClassCacheMinJitDataBytes(long)">setSharedClassCacheMinJitDataBytes</a></span>&#8203;(long&nbsp;value)</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Set the minimum shared classes cache space reserved for JIT data to <code>value</code> bytes.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setSharedClassCacheSoftmxBytes(long)">setSharedClassCacheSoftmxBytes</a></span>&#8203;(long&nbsp;value)</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
 <div class="block">Set the shared class softmx size to <code>value</code>.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods.inherited.from.class.java.lang.management.MemoryMXBean">Methods declared in interface&nbsp;java.lang.management.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryMXBean</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html#gc()" title="class or interface in java.lang.management" class="external-link" target="_blank">gc</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html#getHeapMemoryUsage()" title="class or interface in java.lang.management" class="external-link" target="_blank">getHeapMemoryUsage</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html#getNonHeapMemoryUsage()" title="class or interface in java.lang.management" class="external-link" target="_blank">getNonHeapMemoryUsage</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html#getObjectPendingFinalizationCount()" title="class or interface in java.lang.management" class="external-link" target="_blank">getObjectPendingFinalizationCount</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html#isVerbose()" title="class or interface in java.lang.management" class="external-link" target="_blank">isVerbose</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryMXBean.html#setVerbose(boolean)" title="class or interface in java.lang.management" class="external-link" target="_blank">setVerbose</a></code></div>
 <div class="inherited-list">
 <h3 id="methods.inherited.from.class.java.lang.management.PlatformManagedObject">Methods declared in interface&nbsp;java.lang.management.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html" title="class or interface in java.lang.management" class="external-link" target="_blank">PlatformManagedObject</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html#getObjectName()" title="class or interface in java.lang.management" class="external-link" target="_blank">getObjectName</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method.detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getMaxHeapSizeLimit()">
 <h3>getMaxHeapSizeLimit</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getMaxHeapSizeLimit</span>()</div>
 <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 class="notes">
 <dt>Returns:</dt>
 <dd>value of -Xmx in bytes</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getMaxHeapSize()">
 <h3>getMaxHeapSize</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getMaxHeapSize</span>()</div>
 <div class="block">Get the current maximum heap size in bytes.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>current value of -Xsoftmx in bytes</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getMinHeapSize()">
 <h3>getMinHeapSize</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getMinHeapSize</span>()</div>
 <div class="block">Get the minimum heap size in bytes.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>value of -Xms in bytes</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setMaxHeapSize(long)">
 <h3>setMaxHeapSize</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setMaxHeapSize</span>&#8203;<span class="parameters">(long&nbsp;size)</span></div>
 <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 class="notes">
 <dt>Parameters:</dt>
 <dd><code>size</code> - new -Xsoftmx value in bytes</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link" target="_blank">UnsupportedOperationException</a></code> - if this operation is not supported.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">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/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityManager.html" title="class or interface in java.lang" class="external-link" target="_blank"><code>SecurityManager</code></a> is being used and the caller
              does not have the <code>ManagementPermission</code> value
              of "control".</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isSetMaxHeapSizeSupported()">
 <h3>isSetMaxHeapSizeSupported</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isSetMaxHeapSizeSupported</span>()</div>
 <div class="block">Query whether the VM supports runtime reconfiguration of the
  maximum heap size through the setMaxHeapSize() call.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>true if setMaxHeapSize is supported, false otherwise</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheSize()">
 <h3>getSharedClassCacheSize</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheSize</span>()</div>
 <div class="block">Returns the total size in bytes of the cache that the JVM is currently
  connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the number of bytes in the shared class cache.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheSoftmxBytes()">
 <h3>getSharedClassCacheSoftmxBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheSoftmxBytes</span>()</div>
 <div class="block">Returns the softmx size in bytes of the cache that the JVM is currently
  connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the softmx bytes in the shared class cache or cache size if it is not set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheMinAotBytes()">
 <h3>getSharedClassCacheMinAotBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheMinAotBytes</span>()</div>
 <div class="block">Returns the minimum space reserved for AOT data of the cache that the JVM is currently
  connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the minimum shared classes cache space reserved for AOT data in bytes or -1 if it is not set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheMaxAotBytes()">
 <h3>getSharedClassCacheMaxAotBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheMaxAotBytes</span>()</div>
 <div class="block">Returns the maximum space allowed for AOT data of the cache that the JVM is currently
  connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the maximum shared classes cache space allowed for AOT data or -1 if it is not set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheMinJitDataBytes()">
 <h3>getSharedClassCacheMinJitDataBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheMinJitDataBytes</span>()</div>
 <div class="block">Returns the minimum space reserved for JIT data of the cache that the JVM is currently
  connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the minimum shared classes cache space reserved for JIT data or -1 if it is not set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheMaxJitDataBytes()">
 <h3>getSharedClassCacheMaxJitDataBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheMaxJitDataBytes</span>()</div>
 <div class="block">Returns the maximum space allowed for JIT data of the cache that the JVM is currently
  connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the maximum shared classes cache space allowed for JIT data or -1 if it is not set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSharedClassCacheSoftmxBytes(long)">
 <h3>setSharedClassCacheSoftmxBytes</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">setSharedClassCacheSoftmxBytes</span>&#8203;<span class="parameters">(long&nbsp;value)</span></div>
 <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 class="notes">
 <dt>Parameters:</dt>
 <dd><code>value</code> - new shared cache soft max value in bytes</dd>
 <dt>Returns:</dt>
 <dd>whether the requested operation has been completed.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityManager.html" title="class or interface in java.lang" class="external-link" target="_blank"><code>SecurityManager</code></a> is being used and the caller
              does not have the <code>ManagementPermission</code> value
              of "control".</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSharedClassCacheMinAotBytes(long)">
 <h3>setSharedClassCacheMinAotBytes</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">setSharedClassCacheMinAotBytes</span>&#8203;<span class="parameters">(long&nbsp;value)</span></div>
 <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 class="notes">
 <dt>Parameters:</dt>
 <dd><code>value</code> - new -Xscminaot value in bytes</dd>
 <dt>Returns:</dt>
 <dd>whether the requested operation has been completed.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityManager.html" title="class or interface in java.lang" class="external-link" target="_blank"><code>SecurityManager</code></a> is being used and the caller
              does not have the <code>ManagementPermission</code> value
              of "control".</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSharedClassCacheMaxAotBytes(long)">
 <h3>setSharedClassCacheMaxAotBytes</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">setSharedClassCacheMaxAotBytes</span>&#8203;<span class="parameters">(long&nbsp;value)</span></div>
 <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 class="notes">
 <dt>Parameters:</dt>
 <dd><code>value</code> - new -Xscmaxaot value in bytes</dd>
 <dt>Returns:</dt>
 <dd>whether the requested operation has been completed.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityManager.html" title="class or interface in java.lang" class="external-link" target="_blank"><code>SecurityManager</code></a> is being used and the caller
              does not have the <code>ManagementPermission</code> value
              of "control".</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSharedClassCacheMinJitDataBytes(long)">
 <h3>setSharedClassCacheMinJitDataBytes</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">setSharedClassCacheMinJitDataBytes</span>&#8203;<span class="parameters">(long&nbsp;value)</span></div>
 <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 class="notes">
 <dt>Parameters:</dt>
 <dd><code>value</code> - new -Xscminjitdata value in bytes</dd>
 <dt>Returns:</dt>
 <dd>whether the requested operation has been completed.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityManager.html" title="class or interface in java.lang" class="external-link" target="_blank"><code>SecurityManager</code></a> is being used and the caller
              does not have the <code>ManagementPermission</code> value
              of "control".</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSharedClassCacheMaxJitDataBytes(long)">
 <h3>setSharedClassCacheMaxJitDataBytes</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">setSharedClassCacheMaxJitDataBytes</span>&#8203;<span class="parameters">(long&nbsp;value)</span></div>
 <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 class="notes">
 <dt>Parameters:</dt>
 <dd><code>value</code> - new -Xscmaxjitdata value in bytes</dd>
 <dt>Returns:</dt>
 <dd>whether the requested operation has been completed.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if input value <code>value</code> is less than 0.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" target="_blank">SecurityException</a></code> - if a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityManager.html" title="class or interface in java.lang" class="external-link" target="_blank"><code>SecurityManager</code></a> is being used and the caller
              does not have the <code>ManagementPermission</code> value
              of "control".</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheSoftmxUnstoredBytes()">
 <h3>getSharedClassCacheSoftmxUnstoredBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheSoftmxUnstoredBytes</span>()</div>
 <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 class="notes">
 <dt>Returns:</dt>
 <dd>the unstored bytes.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheMaxAotUnstoredBytes()">
 <h3>getSharedClassCacheMaxAotUnstoredBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheMaxAotUnstoredBytes</span>()</div>
 <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 class="notes">
 <dt>Returns:</dt>
 <dd>the unstored bytes.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheMaxJitDataUnstoredBytes()">
 <h3>getSharedClassCacheMaxJitDataUnstoredBytes</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheMaxJitDataUnstoredBytes</span>()</div>
 <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 class="notes">
 <dt>Returns:</dt>
 <dd>the unstored bytes.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSharedClassCacheFreeSpace()">
 <h3>getSharedClassCacheFreeSpace</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getSharedClassCacheFreeSpace</span>()</div>
 <div class="block">Returns the <b>free space</b> in bytes of the cache that the JVM is
  currently connected to.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the number of bytes free in the shared class cache.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getGCMode()">
 <h3>getGCMode</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getGCMode</span>()</div>
 <div class="block">Returns the current GC mode as a human-readable string.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>a String describing the mode the GC is currently operating in</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getGCMainThreadCpuUsed()">
 <h3>getGCMainThreadCpuUsed</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getGCMainThreadCpuUsed</span>()</div>
 <div class="block">Returns the amount of CPU time spent in the GC by the main thread, in
  milliseconds.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>CPU time used in milliseconds</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getGCWorkerThreadsCpuUsed()">
 <h3>getGCWorkerThreadsCpuUsed</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getGCWorkerThreadsCpuUsed</span>()</div>
 <div class="block">Returns the total amount of CPU time spent in the GC by all worker threads,
  in milliseconds.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>CPU time used in milliseconds</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getMaximumGCThreads()">
 <h3>getMaximumGCThreads</h3>
 <div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getMaximumGCThreads</span>()</div>
 <div class="block">Returns the maximum number of GC worker threads.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>maximum number of GC worker threads</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getCurrentGCThreads()">
 <h3>getCurrentGCThreads</h3>
 <div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getCurrentGCThreads</span>()</div>
 <div class="block">Returns the number of GC worker threads that participated in the most recent collection.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>number of active GC worker threads</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><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/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>