| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>GcInfo (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.sun.management, class: GcInfo"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.sun.management.GcInfo class"> |
| <meta name="keywords" content="getId()"> |
| <meta name="keywords" content="getStartTime()"> |
| <meta name="keywords" content="getEndTime()"> |
| <meta name="keywords" content="getDuration()"> |
| <meta name="keywords" content="getMemoryUsageBeforeGc()"> |
| <meta name="keywords" content="getMemoryUsageAfterGc()"> |
| <meta name="keywords" content="from()"> |
| <meta name="keywords" content="containsKey()"> |
| <meta name="keywords" content="containsValue()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="get()"> |
| <meta name="keywords" content="getAll()"> |
| <meta name="keywords" content="getCompositeType()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="values()"> |
| <meta name="keywords" content="toCompositeData()"> |
| <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/GcInfo.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="../../../module-summary.html">jdk.management</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.sun.management</a></div> |
| <h1 title="Class GcInfo" class="title">Class GcInfo</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.sun.management.GcInfo</div> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeDataView.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeDataView</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">GcInfo</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeDataView.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeDataView</a></span></div> |
| <div class="block">Garbage collection information. It contains the following |
| information for one garbage collection as well as GC-specific |
| attributes: |
| <blockquote> |
| <ul> |
| <li>Start time</li> |
| <li>End time</li> |
| <li>Duration</li> |
| <li>Memory usage before the collection starts</li> |
| <li>Memory usage after the collection ends</li> |
| </ul> |
| </blockquote></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.9</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4 method-summary-table"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#containsKey(java.lang.String)">containsKey</a></span>​(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns <code>true</code> if and only if this <code>CompositeData</code> instance contains |
| an item whose name is <code>key</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#containsValue(java.lang.Object)">containsValue</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns <code>true</code> if and only if this <code>CompositeData</code> instance contains an item |
| whose value is <code>value</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a> obj)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Compares the argument to the receiver, and answers true |
| if they represent the <em>same</em> object using a class |
| specific comparison.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="GcInfo.html" title="class in com.sun.management">GcInfo</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#from(javax.management.openmbean.CompositeData)">from</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a> cd)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns a <code>GcInfo</code> object represented by the |
| given <code>CompositeData</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#get(java.lang.String)">get</a></span>​(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the value of the item whose name is <code>key</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getAll(java.lang.String%5B%5D)">getAll</a></span>​(<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>[] keys)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns an array of the values of the items whose names |
| are specified by <code>keys</code>, in the same order as <code>keys</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeType.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeType</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCompositeType()">getCompositeType</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the <i>composite type </i> of this <i>composite data</i> instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getDuration()">getDuration</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the elapsed time of this GC in milliseconds.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getEndTime()">getEndTime</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the end time of this GC in milliseconds |
| since the Java virtual machine was started.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getId()">getId</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link" target="_blank">Map</a><<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>,​<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryUsage.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryUsage</a>></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getMemoryUsageAfterGc()">getMemoryUsageAfterGc</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the memory usage of all memory pools |
| at the end of this GC.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link" target="_blank">Map</a><<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>,​<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryUsage.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryUsage</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getMemoryUsageBeforeGc()">getMemoryUsageBeforeGc</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the memory usage of all memory pools |
| at the beginning of this GC.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getStartTime()">getStartTime</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the start time of this GC in milliseconds |
| since the Java virtual machine was started.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#hashCode()">hashCode</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Answers an integer hash code for the receiver.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#toCompositeData(javax.management.openmbean.CompositeType)">toCompositeData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeType.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeType</a> ct)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Return the <code>CompositeData</code> representation of this |
| <code>GcInfo</code>, including any GC-specific attributes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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 odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#toString()">toString</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Answers a string containing a concise, human-readable |
| description of the receiver.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link" target="_blank">Collection</a><?></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#values()">values</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns an unmodifiable Collection view of the item values |
| contained in this <code>CompositeData</code> instance.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</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="getId()"> |
| <h3>getId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getId</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the identifier of this garbage collection which is |
| the number of collections that this collector has done.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartTime()"> |
| <h3>getStartTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getStartTime</span>()</div> |
| <div class="block">Returns the start time of this GC in milliseconds |
| since the Java virtual machine was started.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the start time of this GC.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEndTime()"> |
| <h3>getEndTime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEndTime</span>()</div> |
| <div class="block">Returns the end time of this GC in milliseconds |
| since the Java virtual machine was started.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the end time of this GC.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDuration()"> |
| <h3>getDuration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getDuration</span>()</div> |
| <div class="block">Returns the elapsed time of this GC in milliseconds.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the elapsed time of this GC in milliseconds.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryUsageBeforeGc()"> |
| <h3>getMemoryUsageBeforeGc</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link" target="_blank">Map</a><<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>,​<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryUsage.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryUsage</a>></span> <span class="element-name">getMemoryUsageBeforeGc</span>()</div> |
| <div class="block">Returns the memory usage of all memory pools |
| at the beginning of this GC. |
| This method returns |
| a <code>Map</code> of the name of a memory pool |
| to the memory usage of the corresponding |
| memory pool before GC starts.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <code>Map</code> of memory pool names to the memory |
| usage of a memory pool before GC starts.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryUsageAfterGc()"> |
| <h3>getMemoryUsageAfterGc</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link" target="_blank">Map</a><<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>,​<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/MemoryUsage.html" title="class or interface in java.lang.management" class="external-link" target="_blank">MemoryUsage</a>></span> <span class="element-name">getMemoryUsageAfterGc</span>()</div> |
| <div class="block">Returns the memory usage of all memory pools |
| at the end of this GC. |
| This method returns |
| a <code>Map</code> of the name of a memory pool |
| to the memory usage of the corresponding |
| memory pool when GC finishes.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <code>Map</code> of memory pool names to the memory |
| usage of a memory pool when GC finishes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="from(javax.management.openmbean.CompositeData)"> |
| <h3>from</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GcInfo.html" title="class in com.sun.management">GcInfo</a></span> <span class="element-name">from</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a> cd)</span></div> |
| <div class="block">Returns a <code>GcInfo</code> object represented by the |
| given <code>CompositeData</code>. The given |
| <code>CompositeData</code> must contain |
| all the following attributes: |
| |
| <blockquote> |
| <table border=1> |
| <caption>CompositeData attributes</caption> |
| <tr> |
| <th style="text-align:left">Attribute Name</th> |
| <th style="text-align:left">Type</th> |
| </tr> |
| <tr> |
| <td>index</td> |
| <td><code>java.lang.Long</code></td> |
| </tr> |
| <tr> |
| <td>startTime</td> |
| <td><code>java.lang.Long</code></td> |
| </tr> |
| <tr> |
| <td>endTime</td> |
| <td><code>java.lang.Long</code></td> |
| </tr> |
| <tr> |
| <td>memoryUsageBeforeGc</td> |
| <td><code>javax.management.openmbean.TabularData</code></td> |
| </tr> |
| <tr> |
| <td>memoryUsageAfterGc</td> |
| <td><code>javax.management.openmbean.TabularData</code></td> |
| </tr> |
| </table> |
| </blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cd</code> - <code>CompositeData</code> representing a <code>GcInfo</code></dd> |
| <dt>Returns:</dt> |
| <dd>a <code>GcInfo</code> object represented by <code>cd</code> |
| if <code>cd</code> is not <code>null</code>; <code>null</code> otherwise.</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 <code>cd</code> does not |
| represent a <code>GcInfo</code> object with the attributes |
| described above.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsKey(java.lang.String)"> |
| <h3>containsKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsKey</span>​<span class="parameters">(<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> key)</span></div> |
| <div class="block">Returns <code>true</code> if and only if this <code>CompositeData</code> instance contains |
| an item whose name is <code>key</code>. |
| If <code>key</code> is a null or empty String, this method simply returns false.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#containsKey(java.lang.String)" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">containsKey</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key to be tested.</dd> |
| <dt>Returns:</dt> |
| <dd>true if this <code>CompositeData</code> contains the key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsValue(java.lang.Object)"> |
| <h3>containsValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsValue</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a> value)</span></div> |
| <div class="block">Returns <code>true</code> if and only if this <code>CompositeData</code> instance contains an item |
| whose value is <code>value</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#containsValue(java.lang.Object)" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">containsValue</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - the value to be tested.</dd> |
| <dt>Returns:</dt> |
| <dd>true if this <code>CompositeData</code> contains the value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a> obj)</span></div> |
| <div class="block">Compares the argument to the receiver, and answers true |
| if they represent the <em>same</em> object using a class |
| specific comparison. The implementation in Object answers |
| true only if the argument is the exact same object as the |
| receiver (==).</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#equals(java.lang.Object)" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">equals</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>obj</code> - Object |
| the object to compare with this object.</dd> |
| <dt>Returns:</dt> |
| <dd>boolean |
| <code>true</code> |
| if the object is the same as this object |
| <code>false</code> |
| if it is different from this object.</dd> |
| <dt>See Also:</dt> |
| <dd><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank"><code>Object.hashCode()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(java.lang.String)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span> <span class="element-name">get</span>​<span class="parameters">(<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> key)</span></div> |
| <div class="block">Returns the value of the item whose name is <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#get(java.lang.String)" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">get</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the item.</dd> |
| <dt>Returns:</dt> |
| <dd>the value associated with this key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAll(java.lang.String[])"> |
| <h3>getAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>[]</span> <span class="element-name">getAll</span>​<span class="parameters">(<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>[] keys)</span></div> |
| <div class="block">Returns an array of the values of the items whose names |
| are specified by <code>keys</code>, in the same order as <code>keys</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#getAll(java.lang.String%5B%5D)" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">getAll</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>keys</code> - the names of the items.</dd> |
| <dt>Returns:</dt> |
| <dd>the values corresponding to the keys.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCompositeType()"> |
| <h3>getCompositeType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeType.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeType</a></span> <span class="element-name">getCompositeType</span>()</div> |
| <div class="block">Returns the <i>composite type </i> of this <i>composite data</i> instance.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#getCompositeType()" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">getCompositeType</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the type of this CompositeData.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block">Answers an integer hash code for the receiver. Any two |
| objects which answer <code>true</code> when passed to |
| <code>.equals</code> must answer the same value for this |
| method.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#hashCode()" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">hashCode</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the receiver's hash.</dd> |
| <dt>See Also:</dt> |
| <dd><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank"><code>Object.equals(java.lang.Object)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">toString</span>()</div> |
| <div class="block">Answers a string containing a concise, human-readable |
| description of the receiver.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#toString()" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">toString</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>String |
| a printable representation for the receiver.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link" target="_blank">Collection</a><?></span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an unmodifiable Collection view of the item values |
| contained in this <code>CompositeData</code> instance. |
| The returned collection's iterator will return the values |
| in the ascending lexicographic order of the corresponding |
| item names.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html#values()" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">values</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toCompositeData(javax.management.openmbean.CompositeType)"> |
| <h3>toCompositeData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeData.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeData</a></span> <span class="element-name">toCompositeData</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeType.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeType</a> ct)</span></div> |
| <div class="block"><p>Return the <code>CompositeData</code> representation of this |
| <code>GcInfo</code>, including any GC-specific attributes. The |
| returned value will have at least all the attributes described |
| in the <a href="#from(javax.management.openmbean.CompositeData)"><code>from</code></a> method, plus optionally |
| other attributes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeDataView.html#toCompositeData(javax.management.openmbean.CompositeType)" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">toCompositeData</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/openmbean/CompositeDataView.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeDataView</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ct</code> - the <code>CompositeType</code> that the caller expects. |
| This parameter is ignored and can be null.</dd> |
| <dt>Returns:</dt> |
| <dd>the <code>CompositeData</code> representation.</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 © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |