| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>JCImageFactory (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.dtfj, package: com.ibm.dtfj.image.javacore, class: JCImageFactory"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.dtfj.image.javacore.JCImageFactory class"> |
| <meta name="keywords" content="getDTFJMajorVersion()"> |
| <meta name="keywords" content="getDTFJMinorVersion()"> |
| <meta name="keywords" content="getImage()"> |
| <meta name="keywords" content="getImagesFromArchive()"> |
| <meta name="keywords" content="getDTFJModificationLevel()"> |
| <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/JCImageFactory.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.image.javacore</a></div> |
| <h1 title="Class JCImageFactory" class="title">Class JCImageFactory</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.dtfj.image.javacore.JCImageFactory</div> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JCImageFactory</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="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field.summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields.inherited.from.class.com.ibm.dtfj.image.ImageFactory">Fields declared in interface com.ibm.dtfj.image.<a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></h3> |
| <code><a href="../ImageFactory.html#DTFJ_LOGGER_NAME">DTFJ_LOGGER_NAME</a>, <a href="../ImageFactory.html#DTFJ_MAJOR_VERSION">DTFJ_MAJOR_VERSION</a>, <a href="../ImageFactory.html#DTFJ_MINOR_VERSION">DTFJ_MINOR_VERSION</a>, <a href="../ImageFactory.html#SYSTEM_PROPERTY_TMPDIR">SYSTEM_PROPERTY_TMPDIR</a></code></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()">JCImageFactory</a></span>()</code></div> |
| <div class="col-last even-row-color"> </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>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="#getDTFJMajorVersion()">getDTFJMajorVersion</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">Fetch the DTFJ major version number.</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="#getDTFJMinorVersion()">getDTFJMinorVersion</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">Fetch the DTFJ minor version number.</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="#getDTFJModificationLevel()">getDTFJModificationLevel</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">Fetch the DTFJ modification level.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</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="#getImage(java.io.File)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> arg0)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</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="#getImage(java.io.File,java.io.File)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> arg0, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> arg1)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code> and <code>metadata</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</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="#getImage(javax.imageio.stream.ImageInputStream,java.net.URI)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream" class="external-link" target="_blank">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link" target="_blank">URI</a> sourceID)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</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="#getImage(javax.imageio.stream.ImageInputStream,javax.imageio.stream.ImageInputStream,java.net.URI)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream" class="external-link" target="_blank">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream" class="external-link" target="_blank">ImageInputStream</a> meta, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link" target="_blank">URI</a> sourceID)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</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="#getImagesFromArchive(java.io.File,boolean)">getImagesFromArchive</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> archive, |
| boolean extract)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Creates an array of <code>Image</code> objects from an archive such as a zip or jar file.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class 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#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>JCImageFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JCImageFactory</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getDTFJMajorVersion()"> |
| <h3>getDTFJMajorVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getDTFJMajorVersion</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getDTFJMajorVersion()">ImageFactory</a></code></span></div> |
| <div class="block">Fetch the DTFJ major version number.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getDTFJMajorVersion()">getDTFJMajorVersion</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>an integer corresponding to the DTFJ API major version number</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDTFJMinorVersion()"> |
| <h3>getDTFJMinorVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getDTFJMinorVersion</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getDTFJMinorVersion()">ImageFactory</a></code></span></div> |
| <div class="block">Fetch the DTFJ minor version number.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getDTFJMinorVersion()">getDTFJMinorVersion</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>an integer corresponding to the DTFJ API minor version number</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImage(javax.imageio.stream.ImageInputStream,java.net.URI)"> |
| <h3>getImage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</a></span> <span class="element-name">getImage</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream" class="external-link" target="_blank">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link" target="_blank">URI</a> sourceID)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getImage(javax.imageio.stream.ImageInputStream,java.net.URI)">ImageFactory</a></code></span></div> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getImage(javax.imageio.stream.ImageInputStream,java.net.URI)">getImage</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>in</code> - a stream with image information, typically a core file</dd> |
| <dd><code>sourceID</code> - <code>URI</code> identifying the source of the image stream</dd> |
| <dt>Returns:</dt> |
| <dd>an instance of <code>Image</code></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 there's a problem reading the given stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImagesFromArchive(java.io.File,boolean)"> |
| <h3>getImagesFromArchive</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</a>[]</span> <span class="element-name">getImagesFromArchive</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> archive, |
| boolean extract)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getImagesFromArchive(java.io.File,boolean)">ImageFactory</a></code></span></div> |
| <div class="block">Creates an array of <code>Image</code> objects from an archive such as a zip or jar file.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getImagesFromArchive(java.io.File,boolean)">getImagesFromArchive</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>archive</code> - which typically contains one or more diagnostic artifacts</dd> |
| <dd><code>extract</code> - true if the files in the archive should be extracted to a temporary directory</dd> |
| <dt>Returns:</dt> |
| <dd>an array of <code>Image</code>s</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 there's a problem reading the specified archive</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImage(javax.imageio.stream.ImageInputStream,javax.imageio.stream.ImageInputStream,java.net.URI)"> |
| <h3>getImage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</a></span> <span class="element-name">getImage</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream" class="external-link" target="_blank">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream" class="external-link" target="_blank">ImageInputStream</a> meta, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link" target="_blank">URI</a> sourceID)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getImage(javax.imageio.stream.ImageInputStream,javax.imageio.stream.ImageInputStream,java.net.URI)">ImageFactory</a></code></span></div> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getImage(javax.imageio.stream.ImageInputStream,javax.imageio.stream.ImageInputStream,java.net.URI)">getImage</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>in</code> - a stream with image information, typically a core file</dd> |
| <dd><code>meta</code> - a stream with metadata associated with the image stream</dd> |
| <dd><code>sourceID</code> - <code>URI</code> identifying the source of the image stream</dd> |
| <dt>Returns:</dt> |
| <dd>an instance of <code>Image</code></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 there's a problem reading the given streams</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImage(java.io.File)"> |
| <h3>getImage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</a></span> <span class="element-name">getImage</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> arg0)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getImage(java.io.File)">ImageFactory</a></code></span></div> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getImage(java.io.File)">getImage</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>arg0</code> - a file with Image information, typically a core file</dd> |
| <dt>Returns:</dt> |
| <dd>an instance of Image</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 there's a problem reading the specified file</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImage(java.io.File,java.io.File)"> |
| <h3>getImage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Image.html" title="interface in com.ibm.dtfj.image">Image</a></span> <span class="element-name">getImage</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> arg0, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> arg1)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getImage(java.io.File,java.io.File)">ImageFactory</a></code></span></div> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code> and <code>metadata</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getImage(java.io.File,java.io.File)">getImage</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>arg0</code> - a file with image information, typically a core file</dd> |
| <dd><code>arg1</code> - an (implementation-defined) file with additional image information (or null if not required)</dd> |
| <dt>Returns:</dt> |
| <dd>an instance of <code>Image</code></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 there's a problem reading either of the specified files</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDTFJModificationLevel()"> |
| <h3>getDTFJModificationLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getDTFJModificationLevel</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImageFactory.html#getDTFJModificationLevel()">ImageFactory</a></code></span></div> |
| <div class="block">Fetch the DTFJ modification level.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImageFactory.html#getDTFJModificationLevel()">getDTFJModificationLevel</a></code> in interface <code><a href="../ImageFactory.html" title="interface in com.ibm.dtfj.image">ImageFactory</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>an integer corresponding to the DTFJ API modification level</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/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
