| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>GarbageCollectionNotificationInfo (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: GarbageCollectionNotificationInfo"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.sun.management.GarbageCollectionNotificationInfo class"> |
| <meta name="keywords" content="GARBAGE_COLLECTION_NOTIFICATION"> |
| <meta name="keywords" content="getGcName()"> |
| <meta name="keywords" content="getGcAction()"> |
| <meta name="keywords" content="getGcCause()"> |
| <meta name="keywords" content="getGcInfo()"> |
| <meta name="keywords" content="from()"> |
| <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/GarbageCollectionNotificationInfo.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 GarbageCollectionNotificationInfo" class="title">Class GarbageCollectionNotificationInfo</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.GarbageCollectionNotificationInfo</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/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">GarbageCollectionNotificationInfo</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/CompositeDataView.html" title="class or interface in javax.management.openmbean" class="external-link" target="_blank">CompositeDataView</a></span></div> |
| <div class="block">Information about a garbage collection. |
| |
| <p> |
| A garbage collection notification is emitted by <a href="https://docs.oracle.com/en/java/javase/16/docs/api/jdk.management/com/sun/management/GarbageCollectorMXBean.html" title="class or interface in com.sun.management" class="external-link" target="_blank"><code>GarbageCollectorMXBean</code></a> |
| when the Java virtual machine completes a garbage collection action. |
| The notification emitted will contain the garbage collection notification |
| information about the status of the memory: |
| <ul> |
| <li>The name of the garbage collector used perform the collection.</li> |
| <li>The action performed by the garbage collector.</li> |
| <li>The cause of the garbage collection action.</li> |
| <li>A <a href="GcInfo.html" title="class in com.sun.management"><code>GcInfo</code></a> object containing some statistics about the GC cycle |
| (start time, end time) and the memory usage before and after |
| the GC cycle.</li> |
| </ul> |
| |
| <p> |
| A <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"><code>CompositeData</code></a> representing |
| the <code>GarbageCollectionNotificationInfo</code> object |
| is stored in the |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/Notification.html#setUserData(java.lang.Object)" title="class or interface in javax.management" class="external-link" target="_blank">userdata</a> |
| of a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/Notification.html" title="class or interface in javax.management" class="external-link" target="_blank">notification</a>. |
| The <a href="#from(javax.management.openmbean.CompositeData)"><code>from</code></a> method is provided to convert from |
| a <code>CompositeData</code> to a <code>GarbageCollectionNotificationInfo</code> |
| object. For example: |
| |
| <blockquote><pre> |
| Notification notif; |
| |
| // receive the notification emitted by a GarbageCollectorMXBean and save in notif |
| ... |
| |
| String notifType = notif.getType(); |
| if (notifType.equals(GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION)) { |
| // retrieve the garbage collection notification information |
| CompositeData cd = (CompositeData) notif.getUserData(); |
| GarbageCollectionNotificationInfo info = GarbageCollectionNotificationInfo.from(cd); |
| ... |
| } |
| </pre></blockquote> |
| |
| <p> |
| The type of the notification emitted by a <code>GarbageCollectorMXBean</code> is: |
| <ul> |
| <li>A <a href="#GARBAGE_COLLECTION_NOTIFICATION">garbage collection notification</a>. |
| <br>Used by every notification emitted by the garbage collector, the details about |
| the notification are provided in the <a href="#getGcAction()">action</a> String. |
| </li> |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field.summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static <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"><code><span class="member-name-link"><a href="#GARBAGE_COLLECTION_NOTIFICATION">GARBAGE_COLLECTION_NOTIFICATION</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Notification type denoting that the Java virtual machine has completed a garbage collection cycle.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor.summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,com.sun.management.GcInfo)">GarbageCollectionNotificationInfo</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> gcName, |
| <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> gcAction, |
| <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> gcCause, |
| <a href="GcInfo.html" title="class in com.sun.management">GcInfo</a> gcInfo)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new <code>GarbageCollectionNotificationInfo</code> instance.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="GarbageCollectionNotificationInfo.html" title="class in com.sun.management">GarbageCollectionNotificationInfo</a></code></div> |
| <div class="col-second even-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 even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns a <code>GarbageCollectionNotificationInfo</code> object represented by the |
| given <code>CompositeData</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/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="#getGcAction()">getGcAction</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/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-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getGcCause()">getGcCause</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="GcInfo.html" title="class in com.sun.management">GcInfo</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="#getGcInfo()">getGcInfo</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/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-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getGcName()">getGcName</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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.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 odd-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 odd-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>GarbageCollectionNotificationInfo</code>.</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field.detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="GARBAGE_COLLECTION_NOTIFICATION"> |
| <h3>GARBAGE_COLLECTION_NOTIFICATION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">GARBAGE_COLLECTION_NOTIFICATION</span></div> |
| <div class="block">Notification type denoting that the Java virtual machine has completed a garbage collection cycle. |
| This notification is emitted by a GarbageCollectorMXBean. The value of this notification type is |
| "com.ibm.lang.management.gc.notification" which matches RI naming for compatibility.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.sun.management.GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String,java.lang.String,com.sun.management.GcInfo)"> |
| <h3>GarbageCollectionNotificationInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GarbageCollectionNotificationInfo</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> gcName, |
| <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> gcAction, |
| <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> gcCause, |
| <a href="GcInfo.html" title="class in com.sun.management">GcInfo</a> gcInfo)</span></div> |
| <div class="block">Creates a new <code>GarbageCollectionNotificationInfo</code> instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>gcName</code> - the name of the garbage collector used to perform the collection</dd> |
| <dd><code>gcAction</code> - the action of the performed by the garbage collector</dd> |
| <dd><code>gcCause</code> - the cause the garbage collection</dd> |
| <dd><code>gcInfo</code> - a GcInfo object providing statistics about the GC cycle</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getGcName()"> |
| <h3>getGcName</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">getGcName</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of the garbage collector used to perform the collection.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGcAction()"> |
| <h3>getGcAction</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">getGcAction</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the action of the performed by the garbage collector</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGcCause()"> |
| <h3>getGcCause</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">getGcCause</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the cause of the garbage collection</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGcInfo()"> |
| <h3>getGcInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GcInfo.html" title="class in com.sun.management">GcInfo</a></span> <span class="element-name">getGcInfo</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the GC information related to the last garbage collection</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="GarbageCollectionNotificationInfo.html" title="class in com.sun.management">GarbageCollectionNotificationInfo</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>GarbageCollectionNotificationInfo</code> object represented by the |
| given <code>CompositeData</code>. |
| The given <code>CompositeData</code> must contain 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>gcName</td> |
| <td><code>java.lang.String</code></td> |
| </tr> |
| <tr> |
| <td>gcAction</td> |
| <td><code>java.lang.String</code></td> |
| </tr> |
| <tr> |
| <td>gcCause</td> |
| <td><code>java.lang.String</code></td> |
| </tr> |
| <tr> |
| <td>gcInfo</td> |
| <td><code>com.ibm.lang.management.GcInfo</code></td> |
| </tr> |
| </table> |
| </blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cd</code> - <code>CompositeData</code> representing a |
| <code>GarbageCollectionNotificationInfo</code></dd> |
| <dt>Returns:</dt> |
| <dd>a <code>GarbageCollectionNotificationInfo</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>GarbageCollectionNotificationInfo</code> object</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>GarbageCollectionNotificationInfo</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/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> |