Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk16 / openj9.dtfj / com / ibm / dtfj / corereaders / zos / dumpreader / AddressSpace.html
blob: 95d2ca52f1de54b362219270c0f6519f5720cab6 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>AddressSpace (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.corereaders.zos.dumpreader, class: AddressSpace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.dtfj.corereaders.zos.dumpreader.AddressSpace class">
<meta name="keywords" content="dump">
<meta name="keywords" content="asid">
<meta name="keywords" content="addressMap">
<meta name="keywords" content="lastBlockAddress">
<meta name="keywords" content="lastButOneBlockAddress">
<meta name="keywords" content="ranges">
<meta name="keywords" content="WILD_POINTER">
<meta name="keywords" content="getDump()">
<meta name="keywords" content="getRootAddressSpace()">
<meta name="keywords" content="getUserMap()">
<meta name="keywords" content="getAsid()">
<meta name="keywords" content="getAddressRanges()">
<meta name="keywords" content="getUnusedAddressRanges()">
<meta name="keywords" content="getImageInputStream()">
<meta name="keywords" content="roundToPage()">
<meta name="keywords" content="stripTopBit()">
<meta name="keywords" content="getBlockFromCacheOrDisk()">
<meta name="keywords" content="read()">
<meta name="keywords" content="readInt()">
<meta name="keywords" content="readUnsignedByte()">
<meta name="keywords" content="readByte()">
<meta name="keywords" content="readUnsignedShort()">
<meta name="keywords" content="readShort()">
<meta name="keywords" content="readUnsignedInt()">
<meta name="keywords" content="readLong()">
<meta name="keywords" content="readWord()">
<meta name="keywords" content="getWordLength()">
<meta name="keywords" content="readEbcdicString()">
<meta name="keywords" content="readEbcdicCString()">
<meta name="keywords" content="readAsciiString()">
<meta name="keywords" content="readAsciiCString()">
<meta name="keywords" content="readUtf8String()">
<meta name="keywords" content="isValid()">
<meta name="keywords" content="is64bit()">
<meta name="keywords" content="setIs64bit()">
<meta name="keywords" content="toString()">
<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/AddressSpace.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&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.corereaders.zos.dumpreader</a></div>
<h1 title="Class AddressSpace" class="title">Class AddressSpace</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.corereaders.zos.dumpreader.AddressSpace</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link" target="_blank">Serializable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AddressSpace</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="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link" target="_blank">Serializable</a></span></div>
<div class="block">This class represents an address space in an svcdump. It provides the ability to read
the contents of an address amongst other things. Note that in Zebedee as a whole, addresses
are always represented by a long (Java primitive) to avoid the overhead of continually
creating address objects.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../../../serialized-form.html#com.ibm.dtfj.corereaders.zos.dumpreader.AddressSpace">Serialized Form</a></dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected <a href="../util/IntegerMap.html" title="class in com.ibm.dtfj.corereaders.zos.util">IntegerMap</a></code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#addressMap">addressMap</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Mapping of address to file offsets</div>
</div>
<div class="col-first odd-row-color"><code>protected int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#asid">asid</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Our address space id</div>
</div>
<div class="col-first even-row-color"><code>protected <a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">Dump</a></code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#dump">dump</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">The dump we belong to</div>
</div>
<div class="col-first odd-row-color"><code>protected long</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#lastBlockAddress">lastBlockAddress</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">The last block address requested (quick block cache)</div>
</div>
<div class="col-first even-row-color"><code>protected long</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#lastButOneBlockAddress">lastButOneBlockAddress</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">The last but one block address requested (quick block cache)</div>
</div>
<div class="col-first odd-row-color"><code>protected <a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressRange</a>[]</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#ranges">ranges</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Array of AddressRanges</div>
</div>
<div class="col-first even-row-color"><code>static long</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#WILD_POINTER">WILD_POINTER</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Constant used to indicate an uninitialized pointer (for performance reasons
we use primitive longs for pointers rather than objects)</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.dtfj.corereaders.zos.dumpreader.Dump,int)">AddressSpace</a></span>&#8203;(<a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">Dump</a>&nbsp;dump,
int&nbsp;asid)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new AddressSpace belonging to the given Dump and having the given id.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressRange</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="#getAddressRanges()">getAddressRanges</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">Returns an array of all the <a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader"><code>AddressRange</code></a>s in this
address space.</div>
</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="#getAsid()">getAsid</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">Returns the MVS ASID (Address Space Identifier) for this address space.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected byte[]</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="#getBlockFromCacheOrDisk(long)">getBlockFromCacheOrDisk</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">Get the block either from the cache or from disk.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">Dump</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="#getDump()">getDump</a></span>()</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="AddressSpaceImageInputStream.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressSpaceImageInputStream</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="#getImageInputStream()">getImageInputStream</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">Returns an <a href="AddressSpaceImageInputStream.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader"><code>AddressSpaceImageInputStream</code></a> 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><a href="AddressSpace.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressSpace</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="#getRootAddressSpace()">getRootAddressSpace</a></span>()</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="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressRange</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="#getUnusedAddressRanges()">getUnusedAddressRanges</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">Returns an array of all the unused address ranges in 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/Map.html" title="class or interface in java.util" class="external-link" target="_blank">Map</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="#getUserMap()">getUserMap</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">Returns a general purpose Map object that AddressSpace users can use as they see fit.</div>
</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="#getWordLength()">getWordLength</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">Returns the word length in bytes (either 4 or 8 bytes depending on the machine context).</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#is64bit()">is64bit</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">Returns true if this is a 64-bit machine</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#isValid(long)">isValid</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">Returns true if the given address is present in this address space.</div>
</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="#read(long)">read</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">
<div class="block">Read an unsigned byte at the specified address.</div>
</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="#read(long,byte%5B%5D,int,int)">read</a></span>&#8203;(long&nbsp;address,
byte[]&nbsp;b,
int&nbsp;off,
int&nbsp;len)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Reads len bytes of data from the given address into an array of bytes.</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/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</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="#readAsciiCString(long)">readAsciiCString</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">
<div class="block">Read the ASCII string at the given address.</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="#readAsciiString(long)">readAsciiString</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">Read an ASCII String.</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/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</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="#readAsciiString(long,int)">readAsciiString</a></span>&#8203;(long&nbsp;address,
int&nbsp;length)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Read an ASCII String.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>byte</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="#readByte(long)">readByte</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">Read a (signed) byte at the specified address.</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/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</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="#readEbcdicCString(long)">readEbcdicCString</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">
<div class="block">Read an EBCDIC String.</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="#readEbcdicString(long)">readEbcdicString</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">Read an EBCDIC String.</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/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</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="#readEbcdicString(long,int)">readEbcdicString</a></span>&#8203;(long&nbsp;address,
int&nbsp;length)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Read an EBCDIC String.</div>
</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="#readInt(long)">readInt</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">Read an int at the specified address.</div>
</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="#readLong(long)">readLong</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">
<div class="block">Read a long at the specified address.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>short</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="#readShort(long)">readShort</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">Read a (signed) short at the specified address.</div>
</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="#readUnsignedByte(long)">readUnsignedByte</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">
<div class="block">Read an unsigned byte at the specified address.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#readUnsignedInt(long)">readUnsignedInt</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">Read an unsigned int at the specified address.</div>
</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="#readUnsignedShort(long)">readUnsignedShort</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">
<div class="block">Read an unsigned short at the specified address.</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="#readUtf8String(long)">readUtf8String</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">Read a UTF8 String.</div>
</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="#readWord(long)">readWord</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">
<div class="block">Read a word at the specified address.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected long</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="#roundToPage(long)">roundToPage</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">Rounds the address to the base page address and also strips the top bit if in 32-bit mode.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#setIs64bit(boolean)">setIs64bit</a></span>&#8203;(boolean&nbsp;is64bit)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets whether this is a 64-bit machine.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#stripTopBit(long)">stripTopBit</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">Strip the top bit if this is a 32-bit platform</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/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</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="#toString()">toString</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">Returns the address space id as a hex string.</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">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="dump">
<h3>dump</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">Dump</a></span>&nbsp;<span class="element-name">dump</span></div>
<div class="block">The dump we belong to</div>
</section>
</li>
<li>
<section class="detail" id="asid">
<h3>asid</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">asid</span></div>
<div class="block">Our address space id</div>
</section>
</li>
<li>
<section class="detail" id="addressMap">
<h3>addressMap</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../util/IntegerMap.html" title="class in com.ibm.dtfj.corereaders.zos.util">IntegerMap</a></span>&nbsp;<span class="element-name">addressMap</span></div>
<div class="block">Mapping of address to file offsets</div>
</section>
</li>
<li>
<section class="detail" id="lastBlockAddress">
<h3>lastBlockAddress</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">lastBlockAddress</span></div>
<div class="block">The last block address requested (quick block cache)</div>
</section>
</li>
<li>
<section class="detail" id="lastButOneBlockAddress">
<h3>lastButOneBlockAddress</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">lastButOneBlockAddress</span></div>
<div class="block">The last but one block address requested (quick block cache)</div>
</section>
</li>
<li>
<section class="detail" id="ranges">
<h3>ranges</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressRange</a>[]</span>&nbsp;<span class="element-name">ranges</span></div>
<div class="block">Array of AddressRanges</div>
</section>
</li>
<li>
<section class="detail" id="WILD_POINTER">
<h3>WILD_POINTER</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">WILD_POINTER</span></div>
<div class="block">Constant used to indicate an uninitialized pointer (for performance reasons
we use primitive longs for pointers rather than objects)</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../../../constant-values.html#com.ibm.dtfj.corereaders.zos.dumpreader.AddressSpace.WILD_POINTER">Constant Field Values</a></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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.corereaders.zos.dumpreader.Dump,int)">
<h3>AddressSpace</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AddressSpace</span>&#8203;<span class="parameters">(<a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">Dump</a>&nbsp;dump,
int&nbsp;asid)</span></div>
<div class="block">Creates a new AddressSpace belonging to the given Dump and having the given id.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dump</code> - the <a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader"><code>Dump</code></a> this space belongs to</dd>
<dd><code>asid</code> - the address space id</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getDump()">
<h3>getDump</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Dump.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">Dump</a></span>&nbsp;<span class="element-name">getDump</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the Dump we belong to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRootAddressSpace()">
<h3>getRootAddressSpace</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AddressSpace.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressSpace</a></span>&nbsp;<span class="element-name">getRootAddressSpace</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the root address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getUserMap()">
<h3>getUserMap</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/Map.html" title="class or interface in java.util" class="external-link" target="_blank">Map</a></span>&nbsp;<span class="element-name">getUserMap</span>()</div>
<div class="block">Returns a general purpose Map object that AddressSpace users can use as they see fit.
This map is provided as a convenience since users of AddressSpace often want to store
related info somewhere. Care should be taken that nobody else has used the same key -
one way to achieve this would be to use a class object as a key.</div>
</section>
</li>
<li>
<section class="detail" id="getAsid()">
<h3>getAsid</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getAsid</span>()</div>
<div class="block">Returns the MVS ASID (Address Space Identifier) for this address space.</div>
</section>
</li>
<li>
<section class="detail" id="getAddressRanges()">
<h3>getAddressRanges</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressRange</a>[]</span>&nbsp;<span class="element-name">getAddressRanges</span>()</div>
<div class="block">Returns an array of all the <a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader"><code>AddressRange</code></a>s in this
address space. An address range is simply a pair of [low, high] addresses for which
memory is available in the dump.</div>
</section>
</li>
<li>
<section class="detail" id="getUnusedAddressRanges()">
<h3>getUnusedAddressRanges</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AddressRange.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressRange</a>[]</span>&nbsp;<span class="element-name">getUnusedAddressRanges</span>()</div>
<div class="block">Returns an array of all the unused address ranges in the address space. This is
the inverse of <a href="#getAddressRanges()"><code>getAddressRanges()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="getImageInputStream()">
<h3>getImageInputStream</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AddressSpaceImageInputStream.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader">AddressSpaceImageInputStream</a></span>&nbsp;<span class="element-name">getImageInputStream</span>()</div>
<div class="block">Returns an <a href="AddressSpaceImageInputStream.html" title="class in com.ibm.dtfj.corereaders.zos.dumpreader"><code>AddressSpaceImageInputStream</code></a> for this
address space. The ImageInputStream interface provides a wealth of read methods.</div>
</section>
</li>
<li>
<section class="detail" id="roundToPage(long)">
<h3>roundToPage</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">roundToPage</span>&#8203;<span class="parameters">(long&nbsp;address)</span></div>
<div class="block">Rounds the address to the base page address and also strips the top bit if in 32-bit mode.</div>
</section>
</li>
<li>
<section class="detail" id="stripTopBit(long)">
<h3>stripTopBit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">stripTopBit</span>&#8203;<span class="parameters">(long&nbsp;address)</span></div>
<div class="block">Strip the top bit if this is a 32-bit platform</div>
</section>
</li>
<li>
<section class="detail" id="getBlockFromCacheOrDisk(long)">
<h3>getBlockFromCacheOrDisk</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">getBlockFromCacheOrDisk</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Get the block either from the cache or from disk. This protected method is
provided so that MutableAddressSpace has the chance to look in its own cache first.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="read(long)">
<h3>read</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">read</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an unsigned byte at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readInt(long)">
<h3>readInt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">readInt</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an int at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readUnsignedByte(long)">
<h3>readUnsignedByte</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">readUnsignedByte</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an unsigned byte at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readByte(long)">
<h3>readByte</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte</span>&nbsp;<span class="element-name">readByte</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read a (signed) byte at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readUnsignedShort(long)">
<h3>readUnsignedShort</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">readUnsignedShort</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an unsigned short at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readShort(long)">
<h3>readShort</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">short</span>&nbsp;<span class="element-name">readShort</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read a (signed) short at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readUnsignedInt(long)">
<h3>readUnsignedInt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">readUnsignedInt</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an unsigned int at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readLong(long)">
<h3>readLong</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">readLong</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read a long at the specified address.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readWord(long)">
<h3>readWord</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">readWord</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read a word at the specified address. A word is either 32 or 64 bits depending on
the machine context.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getWordLength()">
<h3>getWordLength</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getWordLength</span>()</div>
<div class="block">Returns the word length in bytes (either 4 or 8 bytes depending on the machine context).</div>
</section>
</li>
<li>
<section class="detail" id="read(long,byte[],int,int)">
<h3>read</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">read</span>&#8203;<span class="parameters">(long&nbsp;address,
byte[]&nbsp;b,
int&nbsp;off,
int&nbsp;len)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Reads len bytes of data from the given address into an array of bytes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the address to read from</dd>
<dd><code>b</code> - - the buffer into which the data is read</dd>
<dd><code>off</code> - - the start offset in array b at which the data is written</dd>
<dd><code>len</code> - - the number of bytes to read</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readEbcdicString(long,int)">
<h3>readEbcdicString</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">readEbcdicString</span>&#8203;<span class="parameters">(long&nbsp;address,
int&nbsp;length)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an EBCDIC String. This method expects to find a sequence of EBCDIC bytes at the
given address.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the EBCDIC bytes</dd>
<dd><code>length</code> - the number of bytes to be read</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readEbcdicString(long)">
<h3>readEbcdicString</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">readEbcdicString</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an EBCDIC String. Assumes that address points to the halfword length immediately
followed by the EBCDIC bytes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the EBCDIC bytes</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readEbcdicCString(long)">
<h3>readEbcdicCString</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">readEbcdicCString</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an EBCDIC String. Assumes that address points to a null-terminated EBCDIC string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the EBCDIC bytes</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readAsciiString(long,int)">
<h3>readAsciiString</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">readAsciiString</span>&#8203;<span class="parameters">(long&nbsp;address,
int&nbsp;length)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an ASCII String. This method expects to find a sequence of ASCII bytes at the
given address.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the ASCII bytes</dd>
<dd><code>length</code> - the number of bytes to be read</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readAsciiCString(long)">
<h3>readAsciiCString</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">readAsciiCString</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read the ASCII string at the given address. Assumes that address points to a
null-terminated ASCII C string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the ASCII bytes</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readAsciiString(long)">
<h3>readAsciiString</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">readAsciiString</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read an ASCII String. Assumes that address points to the halfword length immediately
followed by the ASCII bytes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the ASCII bytes</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readUtf8String(long)">
<h3>readUtf8String</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">readUtf8String</span>&#8203;<span class="parameters">(long&nbsp;address)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Read a UTF8 String. Assumes that address points to the halfword length immediately
followed by the utf8 bytes.
XXX Despite the name no UTF8 conversion is done yet! (i.e. assumes ASCII)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>address</code> - the start address of the structure</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code> - if the given address is not present in this address space</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isValid(long)">
<h3>isValid</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isValid</span>&#8203;<span class="parameters">(long&nbsp;address)</span></div>
<div class="block">Returns true if the given address is present in this address space.</div>
</section>
</li>
<li>
<section class="detail" id="is64bit()">
<h3>is64bit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">is64bit</span>()</div>
<div class="block">Returns true if this is a 64-bit machine</div>
</section>
</li>
<li>
<section class="detail" id="setIs64bit(boolean)">
<h3>setIs64bit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setIs64bit</span>&#8203;<span class="parameters">(boolean&nbsp;is64bit)</span></div>
<div class="block">Sets whether this is a 64-bit machine. Unfortunately there is no way of knowing at
the beginning if we are running in 64-bit mode, this is only discovered in le/Caa.
So perhaps this knowledge should only be in the le layer?</div>
</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">Returns the address space id as a hex string.</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>
</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>