blob: dc68cda7951926e439598a9b8b879aadaec43d02 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ImagePointer (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="com.ibm.dtfj.image.ImagePointer interface">
<meta name="keywords" content="getAddress()">
<meta name="keywords" content="getAddressSpace()">
<meta name="keywords" content="add()">
<meta name="keywords" content="isExecutable()">
<meta name="keywords" content="isReadOnly()">
<meta name="keywords" content="isShared()">
<meta name="keywords" content="getPointerAt()">
<meta name="keywords" content="getLongAt()">
<meta name="keywords" content="getIntAt()">
<meta name="keywords" content="getShortAt()">
<meta name="keywords" content="getByteAt()">
<meta name="keywords" content="getFloatAt()">
<meta name="keywords" content="getDoubleAt()">
<meta name="keywords" content="equals()">
<meta name="keywords" content="hashCode()">
<meta name="keywords" content="getProperties()">
<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="ImagePointer (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":6,"i15":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ImagePointer.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.image</a></div>
<h2 title="Interface ImagePointer" class="title">Interface ImagePointer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="j9/corrupt/CorruptImagePointer.html" title="class in com.ibm.dtfj.image.j9.corrupt">CorruptImagePointer</a></code>, <code><a href="j9/ImagePointer.html" title="class in com.ibm.dtfj.image.j9">ImagePointer</a></code>, <code><a href="../../j9ddr/view/dtfj/image/J9DDRImagePointer.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRImagePointer</a></code>, <code><a href="javacore/JCImagePointer.html" title="class in com.ibm.dtfj.image.javacore">JCImagePointer</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ImagePointer</span></pre>
<div class="block">Represents an address in memory. To create an ImagePointer using an absolute address use
<code>com.ibm.dtfj.image.ImageAddressSpace.getPointer()</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ImageAddressSpace.html#getPointer(long)"><code>ImageAddressSpace.getPointer(long)</code></a></dd>
</dl>
</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></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><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(long)">add</a></span>&#8203;(long&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Build a new image pointer offset from this one by the given amount.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAddress()">getAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the unwrapped address, represented as a Java long.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAddressSpace()">getAddressSpace</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the address space to which this pointer belongs.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByteAt(long)">getByteAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDoubleAt(long)">getDoubleAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFloatAt(long)">getFloatAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntAt(long)">getIntAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLongAt(long)">getLongAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPointerAt(long)">getPointerAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</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/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="#getProperties()">getProperties</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the OS-specific properties for this address</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>short</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShortAt(long)">getShortAt</a></span>&#8203;(long&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Get the value at the given offset from this pointer.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<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="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExecutable()">isExecutable</a></span>()</code></th>
<td class="colLast">
<div class="block">Tests memory execute permission.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadOnly()">isReadOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Tests memory read/write permission.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isShared()">isShared</a></span>()</code></th>
<td class="colLast">
<div class="block">Tests memory shared permission.</div>
</td>
</tr>
</table>
</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="getAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre class="methodSignature">long&nbsp;getAddress()</pre>
<div class="block"><p>Get the unwrapped address, represented as a Java long.</p>
<p> Use caution when comparing addresses, as some addresses may be
negative. </p>
<p>Note that, on segmented memory architectures, it may not be
possible to represent all addresses accurately as integers.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unwrapped address, represented as a 64-bit integer.</dd>
</dl>
</li>
</ul>
<a id="getAddressSpace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddressSpace</h4>
<pre class="methodSignature"><a href="ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a>&nbsp;getAddressSpace()</pre>
<div class="block">Get the address space to which this pointer belongs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the address space to which this pointer belongs.</dd>
</dl>
</li>
</ul>
<a id="add(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a>&nbsp;add&#8203;(long&nbsp;offset)</pre>
<div class="block">Build a new image pointer offset from this one by the given amount.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - Offset in bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new ImagePointer based at getAddress() + offset</dd>
</dl>
</li>
</ul>
<a id="isExecutable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExecutable</h4>
<pre class="methodSignature">boolean&nbsp;isExecutable()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre>
<div class="block">Tests memory execute permission.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this memory address is within an executable page.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
</dl>
</li>
</ul>
<a id="isReadOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadOnly</h4>
<pre class="methodSignature">boolean&nbsp;isReadOnly()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre>
<div class="block">Tests memory read/write permission.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this memory address is read-only. False otherwise.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
</dl>
</li>
</ul>
<a id="isShared()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShared</h4>
<pre class="methodSignature">boolean&nbsp;isShared()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre>
<div class="block">Tests memory shared permission.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this memory address is shared between processes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
</dl>
</li>
</ul>
<a id="getPointerAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPointerAt</h4>
<pre class="methodSignature"><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a>&nbsp;getPointerAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer. To determine the number of bytes to skip after this
call to read the next value, use <code>ImageProcess.getPointerSize()</code>. Note: to create an
ImagePointer using an absolute address use <code>com.ibm.dtfj.image.ImageAddressSpace.getPointer()</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 32 or 64-bit pointer stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ImageProcess.html#getPointerSize()"><code>ImageProcess.getPointerSize()</code></a>,
<a href="ImageAddressSpace.html#getPointer(long)"><code>ImageAddressSpace.getPointer(long)</code></a></dd>
</dl>
</li>
</ul>
<a id="getLongAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLongAt</h4>
<pre class="methodSignature">long&nbsp;getLongAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 64-bit long stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</dd>
</dl>
</li>
</ul>
<a id="getIntAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntAt</h4>
<pre class="methodSignature">int&nbsp;getIntAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 32-bit int stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</dd>
</dl>
</li>
</ul>
<a id="getShortAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShortAt</h4>
<pre class="methodSignature">short&nbsp;getShortAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 16-bit short stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</dd>
</dl>
</li>
</ul>
<a id="getByteAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteAt</h4>
<pre class="methodSignature">byte&nbsp;getByteAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 8-bit byte stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</dd>
</dl>
</li>
</ul>
<a id="getFloatAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloatAt</h4>
<pre class="methodSignature">float&nbsp;getFloatAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 32-bit float stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</dd>
</dl>
</li>
</ul>
<a id="getDoubleAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDoubleAt</h4>
<pre class="methodSignature">double&nbsp;getDoubleAt&#8203;(long&nbsp;index)
throws <a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>,
<a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre>
<div class="block">Get the value at the given offset from this pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - an offset (in bytes) from the current position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 64-bit double stored at getAddress() + index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code> - if the memory cannot be read</dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the memory should be in the image, but is missing or corrupted</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 obj refers to the same Image Pointer 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="getProperties()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperties</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;getProperties()</pre>
<div class="block">Get the OS-specific properties for this address</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a table of OS-specific properties for this address.
Values which are commonly available include
<ul>
<li>"readable" -- whether the memory address can be read from</li>
<li>"writable" -- whether the memory address can be written to</li>
<li>"executable" -- whether data in the memory address can be executed</li>
</ul></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.11</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/ImagePointer.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, 2022, IBM Corp. and others.</small></p>
</footer>
</body>
</html>