blob: f99f13dc0d8bc6ef0fad38466436e63211eef442 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>ImageAddressSpace (OpenJ9 JDK 16)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: openj9.dtfj, package: com.ibm.dtfj.image.j9, class: ImageAddressSpace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.dtfj.image.j9.ImageAddressSpace class">
<meta name="keywords" content="getByteOrder()">
<meta name="keywords" content="getCurrentProcess()">
<meta name="keywords" content="getProcesses()">
<meta name="keywords" content="getPointer()">
<meta name="keywords" content="addProcess()">
<meta name="keywords" content="readByteAtIndex()">
<meta name="keywords" content="readPointerAtIndex()">
<meta name="keywords" content="readIntAtIndex()">
<meta name="keywords" content="readLongAtIndex()">
<meta name="keywords" content="readShortAtIndex()">
<meta name="keywords" content="getImageSections()">
<meta name="keywords" content="bytesPerPointer()">
<meta name="keywords" content="toString()">
<meta name="keywords" content="getID()">
<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.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/ImageAddressSpace.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&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.image.j9</a></div>
<h1 title="Class ImageAddressSpace" class="title">Class ImageAddressSpace</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a>
<div class="inheritance">com.ibm.dtfj.image.j9.ImageAddressSpace</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ImageAddressSpace</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a>
implements <a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.dtfj.addressspace.IAbstractAddressSpace,int)">ImageAddressSpace</a></span>&#8203;(<a href="../../addressspace/IAbstractAddressSpace.html" title="interface in com.ibm.dtfj.addressspace">IAbstractAddressSpace</a>&nbsp;memory,
int&nbsp;asid)</code></div>
<div class="col-last even-row-color">&nbsp;</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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addProcess(com.ibm.dtfj.image.ImageProcess)">addProcess</a></span>&#8203;(<a href="../ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a>&nbsp;proc)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#bytesPerPointer()">bytesPerPointer</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">This shouldn't be added to the public API but it is required by the current hashCode algorithm in JavaObject.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteOrder.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteOrder</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getByteOrder()">getByteOrder</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Return the byte order of this address space.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCurrentProcess()">getCurrentProcess</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the process within this address space that caused the image to be created.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getID()">getID</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the system wide identifier for the address space</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getImageSections()">getImageSections</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the raw memory in the address space.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getPointer(long)">getPointer</a></span>&#8203;(long&nbsp;address)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">A factory method for creating pointers into this address space.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getProcesses()">getProcesses</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the set of processes within the address space.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getProperties()">getProperties</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the OS specific properties for this address space.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>byte</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#readByteAtIndex(long)">readByteAtIndex</a></span>&#8203;(long&nbsp;address)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#readIntAtIndex(long)">readIntAtIndex</a></span>&#8203;(long&nbsp;address)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#readLongAtIndex(long)">readLongAtIndex</a></span>&#8203;(long&nbsp;address)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#readPointerAtIndex(long)">readPointerAtIndex</a></span>&#8203;(long&nbsp;address)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>short</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#readShortAtIndex(long)">readShortAtIndex</a></span>&#8203;(long&nbsp;address)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#toString()">toString</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">If available, show the ASID as toString.</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/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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.addressspace.IAbstractAddressSpace,int)">
<h3>ImageAddressSpace</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ImageAddressSpace</span>&#8203;<span class="parameters">(<a href="../../addressspace/IAbstractAddressSpace.html" title="interface in com.ibm.dtfj.addressspace">IAbstractAddressSpace</a>&nbsp;memory,
int&nbsp;asid)</span></div>
</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="getByteOrder()">
<h3>getByteOrder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteOrder.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteOrder</a></span>&nbsp;<span class="element-name">getByteOrder</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ImageAddressSpace.html#getByteOrder()">ImageAddressSpace</a></code></span></div>
<div class="block">Return the byte order of this address space.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getByteOrder()">getByteOrder</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Returns:</dt>
<dd>the byte order of this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCurrentProcess()">
<h3>getCurrentProcess</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a></span>&nbsp;<span class="element-name">getCurrentProcess</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ImageAddressSpace.html#getCurrentProcess()">ImageAddressSpace</a></code></span></div>
<div class="block">Get the process within this address space that caused the image to be created.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getCurrentProcess()">getCurrentProcess</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Returns:</dt>
<dd>the process within this address space which caused
the image to be created, if any. Return null if no individual
process triggered the creation of the image.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getProcesses()">
<h3>getProcesses</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span>&nbsp;<span class="element-name">getProcesses</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ImageAddressSpace.html#getProcesses()">ImageAddressSpace</a></code></span></div>
<div class="block">Get the set of processes within the address space.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getProcesses()">getProcesses</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Returns:</dt>
<dd>an iterator which provides all of the processes
within a given address space.</dd>
<dt>See Also:</dt>
<dd><a href="../ImageProcess.html" title="interface in com.ibm.dtfj.image"><code>ImageProcess</code></a>,
<a href="../CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPointer(long)">
<h3>getPointer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></span>&nbsp;<span class="element-name">getPointer</span>&#8203;<span class="parameters">(long&nbsp;address)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ImageAddressSpace.html#getPointer(long)">ImageAddressSpace</a></code></span></div>
<div class="block">A factory method for creating pointers into this address space.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getPointer(long)">getPointer</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Parameters:</dt>
<dd><code>address</code> - the address to point to.</dd>
<dt>Returns:</dt>
<dd>an ImagePointer for the specified address.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addProcess(com.ibm.dtfj.image.ImageProcess)">
<h3>addProcess</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addProcess</span>&#8203;<span class="parameters">(<a href="../ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a>&nbsp;proc)</span></div>
</section>
</li>
<li>
<section class="detail" id="readByteAtIndex(long)">
<h3>readByteAtIndex</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte</span>&nbsp;<span class="element-name">readByteAtIndex</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readPointerAtIndex(long)">
<h3>readPointerAtIndex</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></span>&nbsp;<span class="element-name">readPointerAtIndex</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readIntAtIndex(long)">
<h3>readIntAtIndex</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">readIntAtIndex</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readLongAtIndex(long)">
<h3>readLongAtIndex</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">readLongAtIndex</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readShortAtIndex(long)">
<h3>readShortAtIndex</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">short</span>&nbsp;<span class="element-name">readShortAtIndex</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="../MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getImageSections()">
<h3>getImageSections</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span>&nbsp;<span class="element-name">getImageSections</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ImageAddressSpace.html#getImageSections()">ImageAddressSpace</a></code></span></div>
<div class="block">Get the raw memory in the address space.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getImageSections()">getImageSections</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Returns:</dt>
<dd>An iterator of all the ImageSections in the address. Their union will be the total process address space.</dd>
<dt>See Also:</dt>
<dd><a href="../ImageSection.html" title="interface in com.ibm.dtfj.image"><code>ImageSection</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="bytesPerPointer()">
<h3>bytesPerPointer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">bytesPerPointer</span>()</div>
<div class="block">This shouldn't be added to the public API but it is required by the current hashCode algorithm in JavaObject.
It may be possible to remove this method if that callsite is changed to a less hackish solution</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the number of bytes in a pointer (4 or 8).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="block">If available, show the ASID as toString.
Change this once getID() is available.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></dd>
<dt>Returns:</dt>
<dd>String
a printable representation for the receiver.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getID()">
<h3>getID</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getID</span>()
throws <span class="exceptions"><a href="../DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="../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="../ImageAddressSpace.html#getID()">ImageAddressSpace</a></code></span></div>
<div class="block">Gets the system wide identifier for the address space</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getID()">getID</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Returns:</dt>
<dd>address space ID</dd>
<dt>Throws:</dt>
<dd><code><a href="../DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
<dd><code><a href="../CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getProperties()">
<h3>getProperties</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></span>&nbsp;<span class="element-name">getProperties</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ImageAddressSpace.html#getProperties()">ImageAddressSpace</a></code></span></div>
<div class="block">Gets the OS specific properties for this address space.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../ImageAddressSpace.html#getProperties()">getProperties</a></code>&nbsp;in interface&nbsp;<code><a href="../ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></code></dd>
<dt>Returns:</dt>
<dd>a set of OS specific properties</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>