blob: 131555ee6ddbaadf1c5223bc2d7414c472b9b1c0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>JavaReference (OpenJ9 JDK 17)</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.j9, class: JavaReference">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.dtfj.java.j9.JavaReference class">
<meta name="keywords" content="getDescription()">
<meta name="keywords" content="getReachability()">
<meta name="keywords" content="getReferenceType()">
<meta name="keywords" content="getRootType()">
<meta name="keywords" content="getSource()">
<meta name="keywords" content="getTarget()">
<meta name="keywords" content="isClassReference()">
<meta name="keywords" content="isObjectReference()">
<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 17</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/JavaReference.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.dtfj.java.j9</a></div>
<h1 title="Class JavaReference" class="title">Class JavaReference</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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.ibm.dtfj.java.j9.JavaReference</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JavaReference</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/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="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></span></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="inherited-list">
<h3 id="fields-inherited-from-class-com.ibm.dtfj.java.JavaReference">Fields declared in interface&nbsp;com.ibm.dtfj.java.<a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></h3>
<code><a href="../JavaReference.html#HEAP_ROOT_CLASSLOADER">HEAP_ROOT_CLASSLOADER</a>, <a href="../JavaReference.html#HEAP_ROOT_FINALIZABLE_OBJ">HEAP_ROOT_FINALIZABLE_OBJ</a>, <a href="../JavaReference.html#HEAP_ROOT_JNI_GLOBAL">HEAP_ROOT_JNI_GLOBAL</a>, <a href="../JavaReference.html#HEAP_ROOT_JNI_LOCAL">HEAP_ROOT_JNI_LOCAL</a>, <a href="../JavaReference.html#HEAP_ROOT_MONITOR">HEAP_ROOT_MONITOR</a>, <a href="../JavaReference.html#HEAP_ROOT_OTHER">HEAP_ROOT_OTHER</a>, <a href="../JavaReference.html#HEAP_ROOT_STACK_LOCAL">HEAP_ROOT_STACK_LOCAL</a>, <a href="../JavaReference.html#HEAP_ROOT_STRINGTABLE">HEAP_ROOT_STRINGTABLE</a>, <a href="../JavaReference.html#HEAP_ROOT_SYSTEM_CLASS">HEAP_ROOT_SYSTEM_CLASS</a>, <a href="../JavaReference.html#HEAP_ROOT_THREAD">HEAP_ROOT_THREAD</a>, <a href="../JavaReference.html#HEAP_ROOT_UNFINALIZED_OBJ">HEAP_ROOT_UNFINALIZED_OBJ</a>, <a href="../JavaReference.html#HEAP_ROOT_UNKNOWN">HEAP_ROOT_UNKNOWN</a>, <a href="../JavaReference.html#REACHABILITY_PHANTOM">REACHABILITY_PHANTOM</a>, <a href="../JavaReference.html#REACHABILITY_SOFT">REACHABILITY_SOFT</a>, <a href="../JavaReference.html#REACHABILITY_STRONG">REACHABILITY_STRONG</a>, <a href="../JavaReference.html#REACHABILITY_UNKNOWN">REACHABILITY_UNKNOWN</a>, <a href="../JavaReference.html#REACHABILITY_WEAK">REACHABILITY_WEAK</a>, <a href="../JavaReference.html#REFERENCE_ARRAY_ELEMENT">REFERENCE_ARRAY_ELEMENT</a>, <a href="../JavaReference.html#REFERENCE_ASSOCIATED_CLASS">REFERENCE_ASSOCIATED_CLASS</a>, <a href="../JavaReference.html#REFERENCE_CLASS">REFERENCE_CLASS</a>, <a href="../JavaReference.html#REFERENCE_CLASS_LOADER">REFERENCE_CLASS_LOADER</a>, <a href="../JavaReference.html#REFERENCE_CLASS_OBJECT">REFERENCE_CLASS_OBJECT</a>, <a href="../JavaReference.html#REFERENCE_CONSTANT_POOL">REFERENCE_CONSTANT_POOL</a>, <a href="../JavaReference.html#REFERENCE_FIELD">REFERENCE_FIELD</a>, <a href="../JavaReference.html#REFERENCE_INTERFACE">REFERENCE_INTERFACE</a>, <a href="../JavaReference.html#REFERENCE_LOADED_CLASS">REFERENCE_LOADED_CLASS</a>, <a href="../JavaReference.html#REFERENCE_PROTECTION_DOMAIN">REFERENCE_PROTECTION_DOMAIN</a>, <a href="../JavaReference.html#REFERENCE_SIGNERS">REFERENCE_SIGNERS</a>, <a href="../JavaReference.html#REFERENCE_STATIC_FIELD">REFERENCE_STATIC_FIELD</a>, <a href="../JavaReference.html#REFERENCE_SUPERCLASS">REFERENCE_SUPERCLASS</a>, <a href="../JavaReference.html#REFERENCE_UNKNOWN">REFERENCE_UNKNOWN</a>, <a href="../JavaReference.html#REFERENCE_UNUSED_14">REFERENCE_UNUSED_14</a></code></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><a href="#%3Cinit%3E(com.ibm.dtfj.java.j9.JavaRuntime,java.lang.Object,long,java.lang.String,int,int,int)" class="member-name-link">JavaReference</a><wbr>(<a href="JavaRuntime.html" title="class in com.ibm.dtfj.java.j9">JavaRuntime</a>&nbsp;javaVM,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>&nbsp;source,
long&nbsp;address,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;description,
int&nbsp;referencetype,
int&nbsp;roottype,
int&nbsp;reachability)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructor</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.ibm.dtfj.java.j9.JavaRuntime,java.lang.Object,java.lang.Object,java.lang.String,int,int,int)" class="member-name-link">JavaReference</a><wbr>(<a href="JavaRuntime.html" title="class in com.ibm.dtfj.java.j9">JavaRuntime</a>&nbsp;javaVM,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>&nbsp;source,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>&nbsp;target,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;description,
int&nbsp;referencetype,
int&nbsp;roottype,
int&nbsp;reachability)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructor</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-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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescription()" class="member-name-link">getDescription</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get a string describing the reference type.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReachability()" class="member-name-link">getReachability</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the reachability of the target object via this specific reference.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReferenceType()" class="member-name-link">getReferenceType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the reference type, as defined in the JVMTI specification.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRootType()" class="member-name-link">getRootType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the root type, as defined in the JVMTI specification.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSource()" class="member-name-link">getSource</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the source of this reference if available.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTarget()" class="member-name-link">getTarget</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the object referred to by this reference.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isClassReference()" class="member-name-link">isClassReference</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Does this reference point to a class?</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isObjectReference()" class="member-name-link">isObjectReference</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Does this reference point to an object in the heap?</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(com.ibm.dtfj.java.j9.JavaRuntime,java.lang.Object,long,java.lang.String,int,int,int)">
<h3>JavaReference</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">JavaReference</span><wbr><span class="parameters">(<a href="JavaRuntime.html" title="class in com.ibm.dtfj.java.j9">JavaRuntime</a>&nbsp;javaVM,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>&nbsp;source,
long&nbsp;address,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;description,
int&nbsp;referencetype,
int&nbsp;roottype,
int&nbsp;reachability)</span></div>
<div class="block">Constructor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>javaVM</code> - JavaRuntime</dd>
<dd><code>source</code> - Object The source of this reference/root, for example the JVM or an object on the heap</dd>
<dd><code>address</code> - long Address of the target object of this reference/root.</dd>
<dd><code>description</code> - String</dd>
<dd><code>referencetype</code> - int Mutually exclusive with respect to roottype.</dd>
<dd><code>roottype</code> - int Mutually exclusive with respect to referencetype.</dd>
<dd><code>reachability</code> - int the strength of the reference (this helps the GC in selection of objects for collection).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(com.ibm.dtfj.java.j9.JavaRuntime,java.lang.Object,java.lang.Object,java.lang.String,int,int,int)">
<h3>JavaReference</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">JavaReference</span><wbr><span class="parameters">(<a href="JavaRuntime.html" title="class in com.ibm.dtfj.java.j9">JavaRuntime</a>&nbsp;javaVM,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>&nbsp;source,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>&nbsp;target,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;description,
int&nbsp;referencetype,
int&nbsp;roottype,
int&nbsp;reachability)</span></div>
<div class="block">Constructor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>javaVM</code> - JavaRuntime</dd>
<dd><code>source</code> - Object The source of this reference/root, for example the JVM or an object on the heap</dd>
<dd><code>target</code> - Object The target object of this reference/root.</dd>
<dd><code>description</code> - String</dd>
<dd><code>referencetype</code> - int Mutually exclusive with respect to roottype.</dd>
<dd><code>roottype</code> - int Mutually exclusive with respect to referencetype.</dd>
<dd><code>reachability</code> - int The strength of the reference (this helps the GC in selection of objects for collection).</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="getDescription()">
<h3>getDescription</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getDescription</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#getDescription()">JavaReference</a></code></span></div>
<div class="block">Get a string describing the reference type.
Implementers should not depend on the contents or identity of this string.
e.g. <q>JNI Weak global reference</q>, <q>Instance field 'MyClass.value'</q>, <q>Constant pool string constant</q></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#getDescription()">getDescription</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>a String describing the reference type</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getReachability()">
<h3>getReachability</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getReachability</span>()
throws <span class="exceptions"><a href="../../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#getReachability()">JavaReference</a></code></span></div>
<div class="block">Get the reachability of the target object via this specific reference.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#getReachability()">getReachability</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>an integer representing the reachability, see the REACHABILITY_ static fields.</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="getReferenceType()">
<h3>getReferenceType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getReferenceType</span>()
throws <span class="exceptions"><a href="../../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#getReferenceType()">JavaReference</a></code></span></div>
<div class="block">Get the reference type, as defined in the JVMTI specification.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#getReferenceType()">getReferenceType</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>an integer representing the reference type, see the REFERENCE_ static fields.</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="getRootType()">
<h3>getRootType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getRootType</span>()
throws <span class="exceptions"><a href="../../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#getRootType()">JavaReference</a></code></span></div>
<div class="block">Get the root type, as defined in the JVMTI specification.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#getRootType()">getRootType</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>an integer representing the root type, see the HEAP_ROOT_ static fields.</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="getSource()">
<h3>getSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span>&nbsp;<span class="element-name">getSource</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#getSource()">JavaReference</a></code></span></div>
<div class="block">Get the source of this reference if available.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#getSource()">getSource</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>a JavaClass, JavaObject, JavaStackFrame or null if unknown</dd>
<dt>Throws:</dt>
<dd><code><a href="../../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></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="getTarget()">
<h3>getTarget</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span>&nbsp;<span class="element-name">getTarget</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#getTarget()">JavaReference</a></code></span></div>
<div class="block">Get the object referred to by this reference.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#getTarget()">getTarget</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>a JavaObject or a JavaClass</dd>
<dt>Throws:</dt>
<dd><code><a href="../../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></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="isClassReference()">
<h3>isClassReference</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isClassReference</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#isClassReference()">JavaReference</a></code></span></div>
<div class="block">Does this reference point to a class?</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#isClassReference()">isClassReference</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>true if the target of this root is a class</dd>
<dt>Throws:</dt>
<dd><code><a href="../../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></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="isObjectReference()">
<h3>isObjectReference</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isObjectReference</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../JavaReference.html#isObjectReference()">JavaReference</a></code></span></div>
<div class="block">Does this reference point to an object in the heap?</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../JavaReference.html#isObjectReference()">isObjectReference</a></code>&nbsp;in interface&nbsp;<code><a href="../JavaReference.html" title="interface in com.ibm.dtfj.java">JavaReference</a></code></dd>
<dt>Returns:</dt>
<dd>true if the target of this root is an object</dd>
<dt>Throws:</dt>
<dd><code><a href="../../image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
<dd><code><a href="../../image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>