blob: 0f06f7503f56fc454082db127e2203418975d4e9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>IImageAddressSpaceBuilder (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="com.ibm.dtfj.javacore.builder.IImageAddressSpaceBuilder interface">
<meta name="keywords" content="getCurrentImageProcessBuilder()">
<meta name="keywords" content="getImageProcessBuilder()">
<meta name="keywords" content="generateImageProcessBuilder()">
<meta name="keywords" content="addImageSection()">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IImageAddressSpaceBuilder (OpenJ9 JDK 11)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IImageAddressSpaceBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.ibm.dtfj.javacore.builder</a></div>
<h2 title="Interface IImageAddressSpaceBuilder" class="title">Interface IImageAddressSpaceBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="javacore/ImageAddressSpaceBuilder.html" title="class in com.ibm.dtfj.javacore.builder.javacore">ImageAddressSpaceBuilder</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IImageAddressSpaceBuilder</span></pre>
<div class="block">Factory for building an com.ibm.dtfj.image.ImageAddressSpace.
An ImageAddressSpace factory contains various ImageProcess factories,
each pertaining to a specific ImageProcess and distinguished by unique ids.
In most cases, there will only be one ImageProcess factory associated with
one ImageAddressSpace factory.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../image/ImageSection.html" title="interface in com.ibm.dtfj.image">ImageSection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addImageSection(java.lang.String,long,long)">addImageSection</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;name,
long&nbsp;base,
long&nbsp;size)</code></th>
<td class="colLast">
<div class="block">Create a new image section with the given name, base address and size
and add it to the list in the ImageAddressSpace.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateImageProcessBuilder(java.lang.String)">generateImageProcessBuilder</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">To associate a new image process to the image address space being built
by this image address space factory, use this interface to create a new
image process factory for the aforementioned image process.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentImageProcessBuilder()">getCurrentImageProcessBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current image process builder (factory) associated
with the image address space factory.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImageProcessBuilder(java.lang.String)">getImageProcessBuilder</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;builderID)</code></th>
<td class="colLast">
<div class="block">In multiple image process scenarios, each image process is associated with
it's own image process factory, and the latter are distinguished by unique
id values.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getCurrentImageProcessBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentImageProcessBuilder</h4>
<pre class="methodSignature"><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a>&nbsp;getCurrentImageProcessBuilder()</pre>
<div class="block">Returns the current image process builder (factory) associated
with the image address space factory. Usually, there is only
one image process, thus one image process factory. In the event
that multiple image processes exist for one image address space,
the current image process factory may be the last image process factory
generated by the image address space factory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current (usually the only) ImageProcess factory. Value must not be null.</dd>
</dl>
</li>
</ul>
<a id="getImageProcessBuilder(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImageProcessBuilder</h4>
<pre class="methodSignature"><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a>&nbsp;getImageProcessBuilder&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;builderID)</pre>
<div class="block">In multiple image process scenarios, each image process is associated with
it's own image process factory, and the latter are distinguished by unique
id values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builderID</code> - unique id of the image process factory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>image process factory if found, or null</dd>
</dl>
</li>
</ul>
<a id="generateImageProcessBuilder(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateImageProcessBuilder</h4>
<pre class="methodSignature"><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a>&nbsp;generateImageProcessBuilder&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;id)
throws <a href="BuilderFailureException.html" title="class in com.ibm.dtfj.javacore.builder">BuilderFailureException</a></pre>
<div class="block">To associate a new image process to the image address space being built
by this image address space factory, use this interface to create a new
image process factory for the aforementioned image process. At least one
image process must exist for an image address space, therefore consequently,
at least one image process factory must be created for each image address space factory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - unique id for image process factory to be added to the image address space factory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>generated image process factory</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="BuilderFailureException.html" title="class in com.ibm.dtfj.javacore.builder">BuilderFailureException</a></code> - if error generating image process factory</dd>
</dl>
</li>
</ul>
<a id="addImageSection(java.lang.String,long,long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addImageSection</h4>
<pre class="methodSignature"><a href="../../image/ImageSection.html" title="interface in com.ibm.dtfj.image">ImageSection</a>&nbsp;addImageSection&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;name,
long&nbsp;base,
long&nbsp;size)</pre>
<div class="block">Create a new image section with the given name, base address and size
and add it to the list in the ImageAddressSpace.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IImageAddressSpaceBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</body>
</html>