| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>JavaRuntime (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: openj9.dtfj, package: com.ibm.dtfj.java, interface: JavaRuntime"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.dtfj.java.JavaRuntime interface"> |
| <meta name="keywords" content="getJavaVM()"> |
| <meta name="keywords" content="getSystemProperty()"> |
| <meta name="keywords" content="getJavaVMInitArgs()"> |
| <meta name="keywords" content="getJavaClassLoaders()"> |
| <meta name="keywords" content="getThreads()"> |
| <meta name="keywords" content="getCompiledMethods()"> |
| <meta name="keywords" content="getMonitors()"> |
| <meta name="keywords" content="getHeaps()"> |
| <meta name="keywords" content="getHeapRoots()"> |
| <meta name="keywords" content="getTraceBuffer()"> |
| <meta name="keywords" content="getObjectAtAddress()"> |
| <meta name="keywords" content="getMemoryCategories()"> |
| <meta name="keywords" content="getMemorySections()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="isJITEnabled()"> |
| <meta name="keywords" content="getJITProperties()"> |
| <meta name="keywords" content="getStartTime()"> |
| <meta name="keywords" content="getStartTimeNanos()"> |
| <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/JavaRuntime.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">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.dtfj.java</a></div> |
| <h1 title="Interface JavaRuntime" class="title">Interface JavaRuntime</h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../runtime/ManagedRuntime.html" title="interface in com.ibm.dtfj.runtime">ManagedRuntime</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../j9ddr/vm29/view/dtfj/java/DTFJJavaRuntime.html" title="class in com.ibm.j9ddr.vm29.view.dtfj.java">DTFJJavaRuntime</a></code>, <code><a href="j9/JavaRuntime.html" title="class in com.ibm.dtfj.java.j9">JavaRuntime</a></code>, <code><a href="javacore/JCJavaRuntime.html" title="class in com.ibm.dtfj.java.javacore">JCJavaRuntime</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">JavaRuntime</span><span class="extends-implements"> |
| extends <a href="../runtime/ManagedRuntime.html" title="interface in com.ibm.dtfj.runtime">ManagedRuntime</a></span></div> |
| <div class="block">Represents a Java runtime.</div> |
| </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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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>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="#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 method-summary-table-tab3"> |
| <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-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></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="#getCompiledMethods()">getCompiledMethods</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">This is short cut method.</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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</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="#getHeapRoots()">getHeapRoots</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 set of object and class roots known to the VM.</div> |
| </div> |
| <div class="col-first odd-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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></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="#getHeaps()">getHeaps</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 set of heaps known by the VM</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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</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="#getJavaClassLoaders()">getJavaClassLoaders</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 set of class loaders active in this VM</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></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="#getJavaVM()">getJavaVM</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 object that represents the virtual machine</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="JavaVMInitArgs.html" title="interface in com.ibm.dtfj.java">JavaVMInitArgs</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="#getJavaVMInitArgs()">getJavaVMInitArgs</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">Fetch the JavaVMInitArgs which were used to create this VM.</div> |
| </div> |
| <div class="col-first odd-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/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></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="#getJITProperties()">getJITProperties</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 any vendor specific properties in use by the JIT for this Java runtime</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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</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="#getMemoryCategories()">getMemoryCategories</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 iterator of the top-level memory categories used by this |
| Java runtime.</div> |
| </div> |
| <div class="col-first odd-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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></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="#getMemorySections(boolean)">getMemorySections</a></span>​(boolean includeFreed)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns an iterator of JavaRuntimeMemorySection objects corresponding to the blocks of memory allocated by the JavaRuntime.</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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</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="#getMonitors()">getMonitors</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">Provides access to the collection of monitors used in the JavaVM.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a></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="#getObjectAtAddress(com.ibm.dtfj.image.ImagePointer)">getObjectAtAddress</a></span>​(<a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a> address)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Gets the object located at address <code>address</code> in the heap.</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="#getStartTime()">getStartTime</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 time when the JVM was started.</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="#getStartTimeNanos()">getStartTimeNanos</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 value of the JVM's high-resolution timer when the JVM was started.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default <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-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getSystemProperty(java.lang.String)">getSystemProperty</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-tab5 method-summary-table"> |
| <div class="block">Get a system property of the virtual machine.</div> |
| </div> |
| <div class="col-first odd-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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></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="#getThreads()">getThreads</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 set of Java threads known by the VM</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/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 method-summary-table-tab3"><code><span class="member-name-link"><a href="#getTraceBuffer(java.lang.String,boolean)">getTraceBuffer</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> bufferName, |
| boolean formatted)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Fetches implementation specific trace buffers, like the verbose GC buffer |
| or the Universal Trace Engine (UTE) buffer</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>int</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="#hashCode()">hashCode</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">Answers an integer hash code for the receiver.</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="#isJITEnabled()">isJITEnabled</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">Determine if the JIT was enabled for this Java runtime.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.com.ibm.dtfj.runtime.ManagedRuntime">Methods declared in interface com.ibm.dtfj.runtime.<a href="../runtime/ManagedRuntime.html" title="interface in com.ibm.dtfj.runtime">ManagedRuntime</a></h3> |
| <code><a href="../runtime/ManagedRuntime.html#getFullVersion()">getFullVersion</a>, <a href="../runtime/ManagedRuntime.html#getVersion()">getVersion</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="getJavaVM()"> |
| <h3>getJavaVM</h3> |
| <div class="member-signature"><span class="return-type"><a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></span> <span class="element-name">getJavaVM</span>() |
| throws <span class="exceptions"><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Get the object that represents the virtual machine</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the address of the JavaVM structure which represents this JVM instance in JNI</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSystemProperty(java.lang.String)"> |
| <h3>getSystemProperty</h3> |
| <div class="member-signature"><span class="modifiers">default</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">getSystemProperty</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> |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Get a system property of the virtual machine.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to retrieve</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the requested system property from this VM</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the system properties are not available</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJavaVMInitArgs()"> |
| <h3>getJavaVMInitArgs</h3> |
| <div class="member-signature"><span class="return-type"><a href="JavaVMInitArgs.html" title="interface in com.ibm.dtfj.java">JavaVMInitArgs</a></span> <span class="element-name">getJavaVMInitArgs</span>() |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Fetch the JavaVMInitArgs which were used to create this VM. |
| See JNI_CreateJavaVM in the JNI Specification for more details.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the JavaVMInitArgs which were used to create this VM.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the arguments are not available</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJavaClassLoaders()"> |
| <h3>getJavaClassLoaders</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getJavaClassLoaders</span>()</div> |
| <div class="block">Get the set of class loaders active in this VM</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an iterator of all of the class loaders within this JavaVM</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaClassLoader.html" title="interface in com.ibm.dtfj.java"><code>JavaClassLoader</code></a>, |
| <a href="../image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreads()"> |
| <h3>getThreads</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getThreads</span>()</div> |
| <div class="block">Get the set of Java threads known by the VM</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an iterator of the JavaThreads in the runtime</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaThread.html" title="interface in com.ibm.dtfj.java"><code>JavaThread</code></a>, |
| <a href="../image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCompiledMethods()"> |
| <h3>getCompiledMethods</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getCompiledMethods</span>()</div> |
| <div class="block">This is short cut method. The same result can be found by iterating over all |
| methods in all class loaders in all classes.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an iterator over all of the JavaMethods in the JavaRuntime which |
| have been compiled</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaMethod.html" title="interface in com.ibm.dtfj.java"><code>JavaMethod</code></a>, |
| <a href="../image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonitors()"> |
| <h3>getMonitors</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getMonitors</span>()</div> |
| <div class="block">Provides access to the collection of monitors used in the JavaVM. This |
| collection includes both monitors associated with managed objects (e.g. object |
| monitors) and monitors associated with internal control structures (e.g. |
| raw monitors)</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an iterator over the collection of monitors</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaMonitor.html" title="interface in com.ibm.dtfj.java"><code>JavaMonitor</code></a>, |
| <a href="../image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaps()"> |
| <h3>getHeaps</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getHeaps</span>()</div> |
| <div class="block">Get the set of heaps known by the VM</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an iterator for all of the Java heaps within this runtime. Heaps |
| may be specific to this JavaVM instance, or may be shared between multiple |
| JavaVM instances</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaHeap.html" title="interface in com.ibm.dtfj.java"><code>JavaHeap</code></a>, |
| <a href="../image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapRoots()"> |
| <h3>getHeapRoots</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getHeapRoots</span>()</div> |
| <div class="block">Get the set of object and class roots known to the VM. |
| Stack frame roots are not included in the set, they can be retrieved using JavaStackFrame.getHeapRoots().</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an iterator over the collection of JavaReferences representing the known global heap roots within this runtime.</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaReference.html" title="interface in com.ibm.dtfj.java"><code>JavaReference</code></a>, |
| <a href="JavaStackFrame.html" title="interface in com.ibm.dtfj.java"><code>JavaStackFrame</code></a>, |
| <a href="../image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraceBuffer(java.lang.String,boolean)"> |
| <h3>getTraceBuffer</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/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span> <span class="element-name">getTraceBuffer</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> bufferName, |
| boolean formatted)</span> |
| throws <span class="exceptions"><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Fetches implementation specific trace buffers, like the verbose GC buffer |
| or the Universal Trace Engine (UTE) buffer</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bufferName</code> - a String naming the buffer to be fetched</dd> |
| <dd><code>formatted</code> - true if formatting should be performed on the buffer, or |
| false if the raw buffer contents should be returned</dd> |
| <dt>Returns:</dt> |
| <dd>an implementation specific result, depending on the parameters</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectAtAddress(com.ibm.dtfj.image.ImagePointer)"> |
| <h3>getObjectAtAddress</h3> |
| <div class="member-signature"><span class="return-type"><a href="JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a></span> <span class="element-name">getObjectAtAddress</span>​<span class="parameters">(<a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a> address)</span> |
| throws <span class="exceptions"><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a>, |
| <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>, |
| <a href="../image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>, |
| <a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Gets the object located at address <code>address</code> in the heap.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - the <code>ImagePointer</code> instance representing the start address of object in the heap;</dd> |
| <dt>Returns:</dt> |
| <dd>the <code>JavaObject</code> instance representing the located object.</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>address</code> is outside the heap's boundaries, or if it doesn't point to the start location of an object;</dd> |
| <dd><code><a href="../image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if <code>address</code> is in the heap but it's not accessible from the dump;</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if any data needed to build the returned instance of <code>JavaObject</code> is corrupt.</dd> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if any data needed to build the returned instance of <code>JavaObject</code> is not available.</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaObject.html" title="interface in com.ibm.dtfj.java"><code>JavaObject</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryCategories()"> |
| <h3>getMemoryCategories</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getMemoryCategories</span>() |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Returns iterator of the top-level memory categories used by this |
| Java runtime.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Iterator of memory categories</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| <dt>Since:</dt> |
| <dd>1.5</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaRuntimeMemoryCategory.html" title="interface in com.ibm.dtfj.java"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemorySections(boolean)"> |
| <h3>getMemorySections</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">getMemorySections</span>​<span class="parameters">(boolean includeFreed)</span> |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Returns an iterator of JavaRuntimeMemorySection objects corresponding to the blocks of memory allocated by the JavaRuntime.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>includeFreed</code> - If true, iterator will iterate over blocks of memory that have been freed, but haven't been re-used yet.</dd> |
| <dt>Returns:</dt> |
| <dd>Iterator of memory sections.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| <dt>Since:</dt> |
| <dd>1.5</dd> |
| <dt>See Also:</dt> |
| <dd><a href="JavaRuntimeMemorySection.html" title="interface in com.ibm.dtfj.java"><code>CorruptData</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><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"><span class="descfrm-type-label">Description copied from class: <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">java.lang.Object</a></code></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>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> - </dd> |
| <dt>Returns:</dt> |
| <dd>True if the given object refers to the same Java Runtime in the image</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="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <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">java.lang.Object</a></code></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>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="isJITEnabled()"> |
| <h3>isJITEnabled</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isJITEnabled</span>() |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Determine if the JIT was enabled for this Java runtime.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the JIT was enabled, false if not</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if it is not possible to determine the JIT status</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dt>Since:</dt> |
| <dd>1.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJITProperties()"> |
| <h3>getJITProperties</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></span> <span class="element-name">getJITProperties</span>() |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Get any vendor specific properties in use by the JIT for this Java runtime</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the set of properties, which may be empty if none were set.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the JIT was not enabled for this runtime</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dt>Since:</dt> |
| <dd>1.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartTime()"> |
| <h3>getStartTime</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getStartTime</span>() |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Get the time when the JVM was started.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the time the JVM was started, in milliseconds since 1970</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the JVM start time is not available</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the JVM start time is corrupted</dd> |
| <dt>Since:</dt> |
| <dd>1.12</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartTimeNanos()"> |
| <h3>getStartTimeNanos</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getStartTimeNanos</span>() |
| throws <span class="exceptions"><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div> |
| <div class="block">Get the value of the JVM's high-resolution timer when the JVM was started.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the value of the high-resolution timer when the JVM was started, in nanoseconds</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the JVM start time is not available</dd> |
| <dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the JVM start time is corrupted</dd> |
| <dt>Since:</dt> |
| <dd>1.12</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> |