| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>IImageAddressSpaceBuilder (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.javacore.builder, interface: IImageAddressSpaceBuilder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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="../../../../../../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/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> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">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> <a href="../../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.dtfj.javacore.builder</a></div> |
| <h1 title="Interface IImageAddressSpaceBuilder" class="title">Interface IImageAddressSpaceBuilder</h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <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> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IImageAddressSpaceBuilder</span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../../image/ImageSection.html" title="interface in com.ibm.dtfj.image">ImageSection</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#addImageSection(java.lang.String,long,long)">addImageSection</a></span>​(<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> name, |
| long base, |
| long size)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#generateImageProcessBuilder(java.lang.String)">generateImageProcessBuilder</a></span>​(<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> id)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getCurrentImageProcessBuilder()">getCurrentImageProcessBuilder</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns the current image process builder (factory) associated |
| with the image address space factory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getImageProcessBuilder(java.lang.String)">getImageProcessBuilder</a></span>​(<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> builderID)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getCurrentImageProcessBuilder()"> |
| <h3>getCurrentImageProcessBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></span> <span class="element-name">getCurrentImageProcessBuilder</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>current (usually the only) ImageProcess factory. Value must not be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImageProcessBuilder(java.lang.String)"> |
| <h3>getImageProcessBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></span> <span class="element-name">getImageProcessBuilder</span>​<span class="parameters">(<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> builderID)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builderID</code> - unique id of the image process factory</dd> |
| <dt>Returns:</dt> |
| <dd>image process factory if found, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generateImageProcessBuilder(java.lang.String)"> |
| <h3>generateImageProcessBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="IImageProcessBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageProcessBuilder</a></span> <span class="element-name">generateImageProcessBuilder</span>​<span class="parameters">(<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> id)</span> |
| throws <span class="exceptions"><a href="BuilderFailureException.html" title="class in com.ibm.dtfj.javacore.builder">BuilderFailureException</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - unique id for image process factory to be added to the image address space factory</dd> |
| <dt>Returns:</dt> |
| <dd>generated image process factory</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addImageSection(java.lang.String,long,long)"> |
| <h3>addImageSection</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../image/ImageSection.html" title="interface in com.ibm.dtfj.image">ImageSection</a></span> <span class="element-name">addImageSection</span>​<span class="parameters">(<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> name, |
| long base, |
| long size)</span></div> |
| <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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
