| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>IImageProcessBuilder (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: IImageProcessBuilder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.dtfj.javacore.builder.IImageProcessBuilder interface"> |
| <meta name="keywords" content="getCurrentJavaRuntimeBuilder()"> |
| <meta name="keywords" content="getJavaRuntimeBuilder()"> |
| <meta name="keywords" content="addLibrary()"> |
| <meta name="keywords" content="addImageThread()"> |
| <meta name="keywords" content="addImageStackSection()"> |
| <meta name="keywords" content="addImageStackFrame()"> |
| <meta name="keywords" content="generateJavaRuntimeBuilder()"> |
| <meta name="keywords" content="setPointerSize()"> |
| <meta name="keywords" content="setSignal()"> |
| <meta name="keywords" content="setCommandLine()"> |
| <meta name="keywords" content="setRegisters()"> |
| <meta name="keywords" content="addEnvironmentVariable()"> |
| <meta name="keywords" content="addRoutine()"> |
| <meta name="keywords" content="setExecutable()"> |
| <meta name="keywords" content="setID()"> |
| <meta name="keywords" content="setCurrentThreadID()"> |
| <meta name="keywords" content="addProperty()"> |
| <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/IImageProcessBuilder.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 IImageProcessBuilder" class="title">Interface IImageProcessBuilder</h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="javacore/ImageProcessBuilder.html" title="class in com.ibm.dtfj.javacore.builder.javacore">ImageProcessBuilder</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IImageProcessBuilder</span></div> |
| <div class="block">Factory for building a com.ibm.dtfj.image.ImageProcess |
| <br> |
| Each Image Process factory must have at least one |
| Java runtime factory that builds <a href="../../java/JavaRuntime.html" title="interface in com.ibm.dtfj.java"><code>JavaRuntime</code></a> |
| <br> |
| Basic support for multiple java runtime factories is present.</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>void</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="#addEnvironmentVariable(java.lang.String,java.lang.String)">addEnvironmentVariable</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, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Add environment variables</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../../image/ImageStackFrame.html" title="interface in com.ibm.dtfj.image">ImageStackFrame</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="#addImageStackFrame(long,java.lang.String,long,long)">addImageStackFrame</a></span>​(long nativeThreadID, |
| <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 baseAddress, |
| long procAddress)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Adds a stack frame to an image thread</div> |
| </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="#addImageStackSection(com.ibm.dtfj.image.ImageThread,com.ibm.dtfj.image.ImageSection)">addImageStackSection</a></span>​(<a href="../../image/ImageThread.html" title="interface in com.ibm.dtfj.image">ImageThread</a> thread, |
| <a href="../../image/ImageSection.html" title="interface in com.ibm.dtfj.image">ImageSection</a> section)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Adds a stack section to an image thread</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../../image/ImageThread.html" title="interface in com.ibm.dtfj.image">ImageThread</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="#addImageThread(long,long,java.util.Properties)">addImageThread</a></span>​(long nativeThreadID, |
| long systemThreadID, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a> properties)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Adds a com.ibm.dtfj.image.ImageThread to the Image process being built.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</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="#addLibrary(java.lang.String)">addLibrary</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)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Will add an com.ibm.dtfj.image.ImageModule for the specified library name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#addProperty(com.ibm.dtfj.image.ImageModule,java.lang.String,java.lang.String)">addProperty</a></span>​(<a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a> library, |
| <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, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Adds/updates a property for the library</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../../image/ImageSymbol.html" title="interface in com.ibm.dtfj.image">ImageSymbol</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="#addRoutine(com.ibm.dtfj.image.ImageModule,java.lang.String,long)">addRoutine</a></span>​(<a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a> library, |
| <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 address)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Add a routine to a module</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="IJavaRuntimeBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IJavaRuntimeBuilder</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="#generateJavaRuntimeBuilder(java.lang.String)">generateJavaRuntimeBuilder</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">Generates a new java runtime factory.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="IJavaRuntimeBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IJavaRuntimeBuilder</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="#getCurrentJavaRuntimeBuilder()">getCurrentJavaRuntimeBuilder</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">At least one java runtime factory must be associated with an image process factory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="IJavaRuntimeBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IJavaRuntimeBuilder</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="#getJavaRuntimeBuilder(java.lang.String)">getJavaRuntimeBuilder</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> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setCommandLine(java.lang.String)">setCommandLine</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> cmdLine)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Set command line if available in javacore.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setCurrentThreadID(long)">setCurrentThreadID</a></span>​(long imageThreadID)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Sets the current thread</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setExecutable(com.ibm.dtfj.image.ImageModule)">setExecutable</a></span>​(<a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a> execMod)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Sets the module as the process executable</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setID(java.lang.String)">setID</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> pid)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Sets the id of the process</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setPointerSize(int)">setPointerSize</a></span>​(int size)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Valid values: 64, 32, or 31 (s390) bits.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setRegisters(java.util.Map)">setRegisters</a></span>​(<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> regs)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Set registers if available in javacore.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</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="#setSignal(int)">setSignal</a></span>​(int signal)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Set signal value if available in javacore.</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="getCurrentJavaRuntimeBuilder()"> |
| <h3>getCurrentJavaRuntimeBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="IJavaRuntimeBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IJavaRuntimeBuilder</a></span> <span class="element-name">getCurrentJavaRuntimeBuilder</span>()</div> |
| <div class="block">At least one java runtime factory must be associated with an image process factory. |
| In multiple runtime environments, the last java runtime generated for this image process |
| may be considered the current java runtime factory.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>current java runtime factory. Must never be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJavaRuntimeBuilder(java.lang.String)"> |
| <h3>getJavaRuntimeBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="IJavaRuntimeBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IJavaRuntimeBuilder</a></span> <span class="element-name">getJavaRuntimeBuilder</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> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builderID</code> - unique id that looks up a java runtime factory</dd> |
| <dt>Returns:</dt> |
| <dd>found java runtime factory, or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addLibrary(java.lang.String)"> |
| <h3>addLibrary</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a></span> <span class="element-name">addLibrary</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)</span></div> |
| <div class="block">Will add an com.ibm.dtfj.image.ImageModule for the specified library name. |
| If the image module already exists, it will return the latter. A null library name |
| returns a null ImageModule.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - shared library to be added to the com.ibm.dtfj.image.ImageProcess being |
| built by this image process factory.</dd> |
| <dt>Returns:</dt> |
| <dd>added/found ImageModule, or null if not added (if the library name isnull)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addImageThread(long,long,java.util.Properties)"> |
| <h3>addImageThread</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../image/ImageThread.html" title="interface in com.ibm.dtfj.image">ImageThread</a></span> <span class="element-name">addImageThread</span>​<span class="parameters">(long nativeThreadID, |
| long systemThreadID, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a> properties)</span> |
| throws <span class="exceptions"><a href="BuilderFailureException.html" title="class in com.ibm.dtfj.javacore.builder">BuilderFailureException</a></span></div> |
| <div class="block">Adds a com.ibm.dtfj.image.ImageThread to the Image process being built. |
| If the arguments are invalid and a valid ImageThread cannot be constructed, |
| error occurs. |
| <br><br> |
| If the thread already exists, it will populate any missing data into the image thread, |
| and return the latter. |
| <br><br> |
| If the thread does not exist, it will create a new ImageThread and register it |
| with the image process being built.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>nativeThreadID</code> - </dd> |
| <dd><code>systemThreadID</code> - </dd> |
| <dd><code>properties</code> - </dd> |
| <dt>Returns:</dt> |
| <dd>generated ImageThread. Must not be null. If a valid image thread cannot be created or found, throw exception.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="BuilderFailureException.html" title="class in com.ibm.dtfj.javacore.builder">BuilderFailureException</a></code> - if valid image thread was not created or found/updated.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addImageStackSection(com.ibm.dtfj.image.ImageThread,com.ibm.dtfj.image.ImageSection)"> |
| <h3>addImageStackSection</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">addImageStackSection</span>​<span class="parameters">(<a href="../../image/ImageThread.html" title="interface in com.ibm.dtfj.image">ImageThread</a> thread, |
| <a href="../../image/ImageSection.html" title="interface in com.ibm.dtfj.image">ImageSection</a> section)</span></div> |
| <div class="block">Adds a stack section to an image thread</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>thread</code> - </dd> |
| <dd><code>section</code> - the area in memory used for the stack</dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addImageStackFrame(long,java.lang.String,long,long)"> |
| <h3>addImageStackFrame</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../image/ImageStackFrame.html" title="interface in com.ibm.dtfj.image">ImageStackFrame</a></span> <span class="element-name">addImageStackFrame</span>​<span class="parameters">(long nativeThreadID, |
| <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 baseAddress, |
| long procAddress)</span></div> |
| <div class="block">Adds a stack frame to an image thread</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>nativeThreadID</code> - </dd> |
| <dd><code>name</code> - of routine</dd> |
| <dd><code>the</code> - address of the frame</dd> |
| <dd><code>the</code> - address of the code</dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generateJavaRuntimeBuilder(java.lang.String)"> |
| <h3>generateJavaRuntimeBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="IJavaRuntimeBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IJavaRuntimeBuilder</a></span> <span class="element-name">generateJavaRuntimeBuilder</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">Generates a new java runtime factory. If generation fails, an exception is thrown. |
| If the java runtime factory already exists, it returns the latter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - unique id to identify a new java runtime factory to be generated</dd> |
| <dt>Returns:</dt> |
| <dd>generated java runtime factory.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="BuilderFailureException.html" title="class in com.ibm.dtfj.javacore.builder">BuilderFailureException</a></code> - if java runtime factory is not created.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPointerSize(int)"> |
| <h3>setPointerSize</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setPointerSize</span>​<span class="parameters">(int size)</span></div> |
| <div class="block">Valid values: 64, 32, or 31 (s390) bits.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pointer</code> - size for this javacore. Usually parsed or computed from the data found in the javacore.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSignal(int)"> |
| <h3>setSignal</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setSignal</span>​<span class="parameters">(int signal)</span></div> |
| <div class="block">Set signal value if available in javacore.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>generic</code> - signal value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCommandLine(java.lang.String)"> |
| <h3>setCommandLine</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setCommandLine</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> cmdLine)</span></div> |
| <div class="block">Set command line if available in javacore.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>command</code> - line string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRegisters(java.util.Map)"> |
| <h3>setRegisters</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setRegisters</span>​<span class="parameters">(<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> regs)</span></div> |
| <div class="block">Set registers if available in javacore.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regs</code> - Map of registers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addEnvironmentVariable(java.lang.String,java.lang.String)"> |
| <h3>addEnvironmentVariable</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addEnvironmentVariable</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, |
| <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> value)</span></div> |
| <div class="block">Add environment variables</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - </dd> |
| <dd><code>value</code> - </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRoutine(com.ibm.dtfj.image.ImageModule,java.lang.String,long)"> |
| <h3>addRoutine</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../image/ImageSymbol.html" title="interface in com.ibm.dtfj.image">ImageSymbol</a></span> <span class="element-name">addRoutine</span>​<span class="parameters">(<a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a> library, |
| <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 address)</span></div> |
| <div class="block">Add a routine to a module</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>library</code> - </dd> |
| <dd><code>name</code> - </dd> |
| <dd><code>address</code> - </dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setExecutable(com.ibm.dtfj.image.ImageModule)"> |
| <h3>setExecutable</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setExecutable</span>​<span class="parameters">(<a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a> execMod)</span></div> |
| <div class="block">Sets the module as the process executable</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>execMod</code> - </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setID(java.lang.String)"> |
| <h3>setID</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setID</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> pid)</span></div> |
| <div class="block">Sets the id of the process</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pid</code> - String</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCurrentThreadID(long)"> |
| <h3>setCurrentThreadID</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setCurrentThreadID</span>​<span class="parameters">(long imageThreadID)</span></div> |
| <div class="block">Sets the current thread</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>imageThreadID</code> - </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addProperty(com.ibm.dtfj.image.ImageModule,java.lang.String,java.lang.String)"> |
| <h3>addProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addProperty</span>​<span class="parameters">(<a href="../../image/ImageModule.html" title="interface in com.ibm.dtfj.image">ImageModule</a> library, |
| <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, |
| <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> value)</span></div> |
| <div class="block">Adds/updates a property for the library</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>library</code> - the module</dd> |
| <dd><code>name</code> - the property name</dd> |
| <dd><code>value</code> - the property value</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |