Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk11 / openj9.dtfj / com / ibm / dtfj / java / JavaRuntime.html
blob: 943320b96507216582e34300f7c75ecfc9cf88fe [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>JavaRuntime (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JavaRuntime (OpenJ9 JDK 11)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":18,"i15":6,"i16":6,"i17":6,"i18":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" 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="navBarCell1Rev">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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../module-summary.html">openj9.dtfj</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.ibm.dtfj.java</a></div>
<h2 title="Interface JavaRuntime" class="title">Interface JavaRuntime</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../runtime/ManagedRuntime.html" title="interface in com.ibm.dtfj.runtime">ManagedRuntime</a></code></dd>
</dl>
<dl>
<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>
<pre>public interface <span class="typeNameLabel">JavaRuntime</span>
extends <a href="../runtime/ManagedRuntime.html" title="interface in com.ibm.dtfj.runtime">ManagedRuntime</a></pre>
<div class="block">Represents a Java runtime.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a>&nbsp;obj)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompiledMethods()">getCompiledMethods</a></span>()</code></th>
<td class="colLast">
<div class="block">This is short cut method.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeapRoots()">getHeapRoots</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the set of object and class roots known to the VM.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaps()">getHeaps</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the set of heaps known by the VM</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaClassLoaders()">getJavaClassLoaders</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the set of class loaders active in this VM</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaVM()">getJavaVM</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the object that represents the virtual machine</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="JavaVMInitArgs.html" title="interface in com.ibm.dtfj.java">JavaVMInitArgs</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaVMInitArgs()">getJavaVMInitArgs</a></span>()</code></th>
<td class="colLast">
<div class="block">Fetch the JavaVMInitArgs which were used to create this VM.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Properties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJITProperties()">getJITProperties</a></span>()</code></th>
<td class="colLast">
<div class="block">Get any vendor specific properties in use by the JIT for this Java runtime</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMemoryCategories()">getMemoryCategories</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns iterator of the top-level memory categories used by this
Java runtime.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMemorySections(boolean)">getMemorySections</a></span>&#8203;(boolean&nbsp;includeFreed)</code></th>
<td class="colLast">
<div class="block">Returns an iterator of JavaRuntimeMemorySection objects corresponding to the blocks of memory allocated by the JavaRuntime.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMonitors()">getMonitors</a></span>()</code></th>
<td class="colLast">
<div class="block">Provides access to the collection of monitors used in the JavaVM.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectAtAddress(com.ibm.dtfj.image.ImagePointer)">getObjectAtAddress</a></span>&#8203;(<a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a>&nbsp;address)</code></th>
<td class="colLast">
<div class="block">Gets the object located at address <code>address</code> in the heap.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartTime()">getStartTime</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the time when the JVM was started.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartTimeNanos()">getStartTimeNanos</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the value of the JVM's high-resolution timer when the JVM was started.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSystemProperty(java.lang.String)">getSystemProperty</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Get a system property of the virtual machine.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThreads()">getThreads</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the set of Java threads known by the VM</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTraceBuffer(java.lang.String,boolean)">getTraceBuffer</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;bufferName,
boolean&nbsp;formatted)</code></th>
<td class="colLast">
<div class="block">Fetches implementation specific trace buffers, like the verbose GC buffer
or the Universal Trace Engine (UTE) buffer</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Answers an integer hash code for the receiver.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isJITEnabled()">isJITEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Determine if the JIT was enabled for this Java runtime.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.ibm.dtfj.runtime.ManagedRuntime">
<!-- -->
</a>
<h3>Methods declared in interface&nbsp;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></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getJavaVM()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJavaVM</h4>
<pre class="methodSignature"><a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a>&nbsp;getJavaVM()
throws <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the object that represents the virtual machine</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the address of the JavaVM structure which represents this JVM instance in JNI</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd>
</dl>
</li>
</ul>
<a id="getSystemProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemProperty</h4>
<pre class="methodSignature">default&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getSystemProperty&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;key)
throws <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></pre>
<div class="block">Get a system property of the virtual machine.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the name of the property to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the requested system property from this VM</dd>
<dt><span class="throwsLabel">Throws:</span></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>
</li>
</ul>
<a id="getJavaVMInitArgs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJavaVMInitArgs</h4>
<pre class="methodSignature"><a href="JavaVMInitArgs.html" title="interface in com.ibm.dtfj.java">JavaVMInitArgs</a>&nbsp;getJavaVMInitArgs()
throws <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></pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the JavaVMInitArgs which were used to create this VM.</dd>
<dt><span class="throwsLabel">Throws:</span></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>
</li>
</ul>
<a id="getJavaClassLoaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJavaClassLoaders</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getJavaClassLoaders()</pre>
<div class="block">Get the set of class loaders active in this VM</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator of all of the class loaders within this JavaVM</dd>
<dt><span class="seeLabel">See Also:</span></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>
</li>
</ul>
<a id="getThreads()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreads</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getThreads()</pre>
<div class="block">Get the set of Java threads known by the VM</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator of the JavaThreads in the runtime</dd>
<dt><span class="seeLabel">See Also:</span></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>
</li>
</ul>
<a id="getCompiledMethods()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompiledMethods</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getCompiledMethods()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over all of the JavaMethods in the JavaRuntime which
have been compiled</dd>
<dt><span class="seeLabel">See Also:</span></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>
</li>
</ul>
<a id="getMonitors()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMonitors</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getMonitors()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over the collection of monitors</dd>
<dt><span class="seeLabel">See Also:</span></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>
</li>
</ul>
<a id="getHeaps()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaps</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getHeaps()</pre>
<div class="block">Get the set of heaps known by the VM</div>
<dl>
<dt><span class="returnLabel">Returns:</span></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><span class="seeLabel">See Also:</span></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>
</li>
</ul>
<a id="getHeapRoots()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeapRoots</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getHeapRoots()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over the collection of JavaReferences representing the known global heap roots within this runtime.</dd>
<dt><span class="seeLabel">See Also:</span></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>
</li>
</ul>
<a id="getTraceBuffer(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraceBuffer</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a>&nbsp;getTraceBuffer&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;bufferName,
boolean&nbsp;formatted)
throws <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Fetches implementation specific trace buffers, like the verbose GC buffer
or the Universal Trace Engine (UTE) buffer</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>an implementation specific result, depending on the parameters</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd>
</dl>
</li>
</ul>
<a id="getObjectAtAddress(com.ibm.dtfj.image.ImagePointer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectAtAddress</h4>
<pre class="methodSignature"><a href="JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a>&nbsp;getObjectAtAddress&#8203;(<a href="../image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a>&nbsp;address)
throws <a href="../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a>,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink" 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></pre>
<div class="block">Gets the object located at address <code>address</code> in the heap.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - the <code>ImagePointer</code> instance representing the start address of object in the heap;</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>JavaObject</code> instance representing the located object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink" 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><span class="seeLabel">See Also:</span></dt>
<dd><a href="JavaObject.html" title="interface in com.ibm.dtfj.java"><code>JavaObject</code></a></dd>
</dl>
</li>
</ul>
<a id="getMemoryCategories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemoryCategories</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getMemoryCategories()
throws <a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre>
<div class="block">Returns iterator of the top-level memory categories used by this
Java runtime.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Iterator of memory categories</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JavaRuntimeMemoryCategory.html" title="interface in com.ibm.dtfj.java"><code>CorruptData</code></a></dd>
</dl>
</li>
</ul>
<a id="getMemorySections(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemorySections</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getMemorySections&#8203;(boolean&nbsp;includeFreed)
throws <a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre>
<div class="block">Returns an iterator of JavaRuntimeMemorySection objects corresponding to the blocks of memory allocated by the JavaRuntime.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>Iterator of memory sections.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JavaRuntimeMemorySection.html" title="interface in com.ibm.dtfj.java"><code>CorruptData</code></a></dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">boolean&nbsp;equals&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a>&nbsp;obj)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink" 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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink" target="_blank">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the given object refers to the same Java Runtime in the image</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink" target="_blank"><code>Object.hashCode()</code></a></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">int&nbsp;hashCode()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink" 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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink" target="_blank">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the receiver's hash.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink" target="_blank"><code>Object.equals(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a id="isJITEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJITEnabled</h4>
<pre class="methodSignature">boolean&nbsp;isJITEnabled()
throws <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></pre>
<div class="block">Determine if the JIT was enabled for this Java runtime.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the JIT was enabled, false if not</dd>
<dt><span class="throwsLabel">Throws:</span></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><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8</dd>
</dl>
</li>
</ul>
<a id="getJITProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJITProperties</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Properties</a>&nbsp;getJITProperties()
throws <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></pre>
<div class="block">Get any vendor specific properties in use by the JIT for this Java runtime</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of properties, which may be empty if none were set.</dd>
<dt><span class="throwsLabel">Throws:</span></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><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8</dd>
</dl>
</li>
</ul>
<a id="getStartTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre class="methodSignature">long&nbsp;getStartTime()
throws <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></pre>
<div class="block">Get the time when the JVM was started.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time the JVM was started, in milliseconds since 1970</dd>
<dt><span class="throwsLabel">Throws:</span></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><span class="simpleTagLabel">Since:</span></dt>
<dd>1.12</dd>
</dl>
</li>
</ul>
<a id="getStartTimeNanos()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStartTimeNanos</h4>
<pre class="methodSignature">long&nbsp;getStartTimeNanos()
throws <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></pre>
<div class="block">Get the value of the JVM's high-resolution timer when the JVM was started.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the high-resolution timer when the JVM was started, in nanoseconds</dd>
<dt><span class="throwsLabel">Throws:</span></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><span class="simpleTagLabel">Since:</span></dt>
<dd>1.12</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" 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="navBarCell1Rev">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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</body>
</html>