| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ImagePointer (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.image, interface: ImagePointer"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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="../../../../../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.6.0.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/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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-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> <a href="../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.dtfj.image</a></div> |
| <h1 title="Interface ImagePointer" class="title">Interface ImagePointer</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <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> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ImagePointer</span></div> |
| <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 class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="ImageAddressSpace.html#getPointer(long)"><code>ImageAddressSpace.getPointer(long)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></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-tab3"><code><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(long)" class="member-name-link">add</a><wbr>(long offset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Build a new image pointer offset from this one by the given amount.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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> obj)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Compares the argument to the receiver, and answers true |
| if they represent the <em>same</em> object using a class |
| specific comparison.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAddress()" class="member-name-link">getAddress</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the unwrapped address, represented as a Java long.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAddressSpace()" class="member-name-link">getAddressSpace</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the address space to which this pointer belongs.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getByteAt(long)" class="member-name-link">getByteAt</a><wbr>(long index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDoubleAt(long)" class="member-name-link">getDoubleAt</a><wbr>(long index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFloatAt(long)" class="member-name-link">getFloatAt</a><wbr>(long index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getIntAt(long)" class="member-name-link">getIntAt</a><wbr>(long index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLongAt(long)" class="member-name-link">getLongAt</a><wbr>(long index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPointerAt(long)" class="member-name-link">getPointerAt</a><wbr>(long index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getProperties()" class="member-name-link">getProperties</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the OS-specific properties for this address</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>short</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getShortAt(long)" class="member-name-link">getShortAt</a><wbr>(long index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Answers an integer hash code for the receiver.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isExecutable()" class="member-name-link">isExecutable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Tests memory execute permission.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Tests memory read/write permission.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isShared()" class="member-name-link">isShared</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Tests memory shared permission.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getAddress()"> |
| <h3>getAddress</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getAddress</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the unwrapped address, represented as a 64-bit integer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAddressSpace()"> |
| <h3>getAddressSpace</h3> |
| <div class="member-signature"><span class="return-type"><a href="ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></span> <span class="element-name">getAddressSpace</span>()</div> |
| <div class="block">Get the address space to which this pointer belongs.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the address space to which this pointer belongs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(long)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></span> <span class="element-name">add</span><wbr><span class="parameters">(long offset)</span></div> |
| <div class="block">Build a new image pointer offset from this one by the given amount.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - Offset in bytes.</dd> |
| <dt>Returns:</dt> |
| <dd>a new ImagePointer based at getAddress() + offset</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isExecutable()"> |
| <h3>isExecutable</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isExecutable</span>() |
| throws <span class="exceptions"><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Tests memory execute permission.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this memory address is within an executable page.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isReadOnly()"> |
| <h3>isReadOnly</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isReadOnly</span>() |
| throws <span class="exceptions"><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Tests memory read/write permission.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this memory address is read-only. False otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isShared()"> |
| <h3>isShared</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isShared</span>() |
| throws <span class="exceptions"><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Tests memory shared permission.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this memory address is shared between processes.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPointerAt(long)"> |
| <h3>getPointerAt</h3> |
| <div class="member-signature"><span class="return-type"><a href="ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></span> <span class="element-name">getPointerAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 32 or 64-bit pointer stored at getAddress() + index</dd> |
| <dt>Throws:</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>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="ImageProcess.html#getPointerSize()"><code>ImageProcess.getPointerSize()</code></a></li> |
| <li><a href="ImageAddressSpace.html#getPointer(long)"><code>ImageAddressSpace.getPointer(long)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLongAt(long)"> |
| <h3>getLongAt</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getLongAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 64-bit long stored at getAddress() + index</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIntAt(long)"> |
| <h3>getIntAt</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getIntAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 32-bit int stored at getAddress() + index</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShortAt(long)"> |
| <h3>getShortAt</h3> |
| <div class="member-signature"><span class="return-type">short</span> <span class="element-name">getShortAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 16-bit short stored at getAddress() + index</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getByteAt(long)"> |
| <h3>getByteAt</h3> |
| <div class="member-signature"><span class="return-type">byte</span> <span class="element-name">getByteAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 8-bit byte stored at getAddress() + index</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFloatAt(long)"> |
| <h3>getFloatAt</h3> |
| <div class="member-signature"><span class="return-type">float</span> <span class="element-name">getFloatAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 32-bit float stored at getAddress() + index</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDoubleAt(long)"> |
| <h3>getDoubleAt</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">getDoubleAt</span><wbr><span class="parameters">(long index)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Get the value at the given offset from this pointer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - an offset (in bytes) from the current position</dd> |
| <dt>Returns:</dt> |
| <dd>the 64-bit double stored at getAddress() + index</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> obj)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="https://docs.oracle.com/en/java/javase/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">java.lang.Object</a></code></span></div> |
| <div class="block">Compares the argument to the receiver, and answers true |
| if they represent the <em>same</em> object using a class |
| specific comparison. The implementation in Object answers |
| true only if the argument is the exact same object as the |
| receiver (==).</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/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></code> in class <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></dd> |
| <dt>Parameters:</dt> |
| <dd><code>obj</code> - </dd> |
| <dt>Returns:</dt> |
| <dd>True obj refers to the same Image Pointer in the image</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><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"><code>Object.hashCode()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a></code></span></div> |
| <div class="block">Answers an integer hash code for the receiver. Any two |
| objects which answer <code>true</code> when passed to |
| <code>.equals</code> must answer the same value for this |
| method.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the receiver's hash.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><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"><code>Object.equals(java.lang.Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperties()"> |
| <h3>getProperties</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></span> <span class="element-name">getProperties</span>()</div> |
| <div class="block">Get the OS-specific properties for this address</div> |
| <dl class="notes"> |
| <dt>Returns:</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>Since:</dt> |
| <dd>1.11</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2022 IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |