| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ImageFactory (OpenJ9 JDK 11)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="keywords" content="com.ibm.dtfj.image.ImageFactory interface"> |
| <meta name="keywords" content="DTFJ_MAJOR_VERSION"> |
| <meta name="keywords" content="DTFJ_MINOR_VERSION"> |
| <meta name="keywords" content="DTFJ_LOGGER_NAME"> |
| <meta name="keywords" content="SYSTEM_PROPERTY_TMPDIR"> |
| <meta name="keywords" content="getImage()"> |
| <meta name="keywords" content="getImagesFromArchive()"> |
| <meta name="keywords" content="getDTFJMajorVersion()"> |
| <meta name="keywords" content="getDTFJMinorVersion()"> |
| <meta name="keywords" content="getDTFJModificationLevel()"> |
| <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.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.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="ImageFactory (OpenJ9 JDK 11)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/ImageFactory.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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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"> </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> <a href="../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.ibm.dtfj.image</a></div> |
| <h2 title="Interface ImageFactory" class="title">Interface ImageFactory</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="j9/DTFJImageFactory.html" title="class in com.ibm.dtfj.image.j9">DTFJImageFactory</a></code>, <code><a href="j9/ImageFactory.html" title="class in com.ibm.dtfj.image.j9">ImageFactory</a></code>, <code><a href="javacore/JCImageFactory.html" title="class in com.ibm.dtfj.image.javacore">JCImageFactory</a></code>, <code><a href="../phd/PHDImageFactory.html" title="class in com.ibm.dtfj.phd">PHDImageFactory</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ImageFactory</span></pre> |
| <div class="block"><p>This interface is used for classes which can produce instances of Image |
| implementers.</p> |
| |
| <p>Classes that implement this interface should provide a zero argument, public |
| constructor so that they can be created using <code>Class.newInstance()</code>.</p> |
| |
| e.g. |
| |
| <pre> |
| Image image; |
| try { |
| Class<?> factoryClass = Class.forName("com.ibm.dtfj.image.j9.ImageFactory"); |
| ImageFactory factory = (ImageFactory) factoryClass.newInstance(); |
| image = factory.getImage(new File(coreFileName), new File(xmlFileName)); |
| } catch (ClassNotFoundException e) { |
| System.err.println("Could not find DTFJ factory class:"); |
| e.printStackTrace(System.err); |
| } catch (IllegalAccessException e) { |
| System.err.println("Could not instantiate DTFJ factory class:"); |
| e.printStackTrace(System.err); |
| } catch (InstantiationException e) { |
| System.err.println("Could not instantiate DTFJ factory class:"); |
| e.printStackTrace(System.err); |
| } catch (IOException e) { |
| System.err.println("Could not find file required for bootstrapping:"); |
| e.printStackTrace(System.err); |
| } |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DTFJ_LOGGER_NAME">DTFJ_LOGGER_NAME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">This is the name of the <code>java.util.logging.Logger</code> subsystem |
| to which DTFJ passes verbose messages.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DTFJ_MAJOR_VERSION">DTFJ_MAJOR_VERSION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The major version number of the current API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DTFJ_MINOR_VERSION">DTFJ_MINOR_VERSION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The minor version number of the current API.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SYSTEM_PROPERTY_TMPDIR">SYSTEM_PROPERTY_TMPDIR</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">If the image is to be created from a core file inside an archive, this property |
| controls where the file will extracted.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDTFJMajorVersion()">getDTFJMajorVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Fetch the DTFJ major version number.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDTFJMinorVersion()">getDTFJMinorVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Fetch the DTFJ minor version number.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDTFJModificationLevel()">getDTFJModificationLevel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Fetch the DTFJ modification level.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImage(java.io.File)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> imageFile)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImage(java.io.File,java.io.File)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> imageFile, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> metadata)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code> and <code>metadata</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImage(javax.imageio.stream.ImageInputStream,java.net.URI)">getImage</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html?is-external=true" target="_blank" title="class or interface in javax.imageio.stream" class="externalLink">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" target="_blank" title="class or interface in java.net" class="externalLink">URI</a> sourceID)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><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/11/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html?is-external=true" target="_blank" title="class or interface in javax.imageio.stream" class="externalLink">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html?is-external=true" target="_blank" title="class or interface in javax.imageio.stream" class="externalLink">ImageInputStream</a> metadata, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" target="_blank" title="class or interface in java.net" class="externalLink">URI</a> sourceID)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImagesFromArchive(java.io.File,boolean)">getImagesFromArchive</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> archive, |
| boolean extract)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an array of <code>Image</code> objects from an archive such as a zip or jar file.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="DTFJ_MAJOR_VERSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DTFJ_MAJOR_VERSION</h4> |
| <pre>static final int DTFJ_MAJOR_VERSION</pre> |
| <div class="block">The major version number of the current API.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#com.ibm.dtfj.image.ImageFactory.DTFJ_MAJOR_VERSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DTFJ_MINOR_VERSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DTFJ_MINOR_VERSION</h4> |
| <pre>static final int DTFJ_MINOR_VERSION</pre> |
| <div class="block">The minor version number of the current API.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#com.ibm.dtfj.image.ImageFactory.DTFJ_MINOR_VERSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DTFJ_LOGGER_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DTFJ_LOGGER_NAME</h4> |
| <pre>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">String</a> DTFJ_LOGGER_NAME</pre> |
| <div class="block">This is the name of the <code>java.util.logging.Logger</code> subsystem |
| to which DTFJ passes verbose messages.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#com.ibm.dtfj.image.ImageFactory.DTFJ_LOGGER_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SYSTEM_PROPERTY_TMPDIR"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SYSTEM_PROPERTY_TMPDIR</h4> |
| <pre>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">String</a> SYSTEM_PROPERTY_TMPDIR</pre> |
| <div class="block">If the image is to be created from a core file inside an archive, this property |
| controls where the file will extracted. If this is not specified then the value of |
| java.io.tmpdir will be used.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.10</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#com.ibm.dtfj.image.ImageFactory.SYSTEM_PROPERTY_TMPDIR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getImage(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImage</h4> |
| <pre class="methodSignature"><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a> getImage​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> imageFile) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>imageFile</code> - a file with Image information, typically a core file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of Image</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></code> - if there's a problem reading the specified file</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if <code>imageFile</code> is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getImage(javax.imageio.stream.ImageInputStream,java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImage</h4> |
| <pre class="methodSignature"><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a> getImage​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html?is-external=true" target="_blank" title="class or interface in javax.imageio.stream" class="externalLink">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" target="_blank" title="class or interface in java.net" class="externalLink">URI</a> sourceID) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of <code>Image</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></code> - if there's a problem reading the given stream</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if the factory does not support this method</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if either of <code>in</code> or <code>sourceID</code> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.10</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getImage(javax.imageio.stream.ImageInputStream,javax.imageio.stream.ImageInputStream,java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImage</h4> |
| <pre class="methodSignature"><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a> getImage​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html?is-external=true" target="_blank" title="class or interface in javax.imageio.stream" class="externalLink">ImageInputStream</a> in, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/stream/ImageInputStream.html?is-external=true" target="_blank" title="class or interface in javax.imageio.stream" class="externalLink">ImageInputStream</a> metadata, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" target="_blank" title="class or interface in java.net" class="externalLink">URI</a> sourceID) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of the given input stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>in</code> - a stream with image information, typically a core file</dd> |
| <dd><code>metadata</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><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of <code>Image</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></code> - if there's a problem reading the given streams</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if the factory does not support this method</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if any of <code>in</code>, <code>metadata</code> or <code>sourceID</code> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.10</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getImagesFromArchive(java.io.File,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImagesFromArchive</h4> |
| <pre class="methodSignature"><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a>[] getImagesFromArchive​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> archive, |
| boolean extract) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Creates an array of <code>Image</code> objects from an archive such as a zip or jar file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of <code>Image</code>s</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></code> - if there's a problem reading the specified archive</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if the factory does not support this method</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.10</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getImage(java.io.File,java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImage</h4> |
| <pre class="methodSignature"><a href="Image.html" title="interface in com.ibm.dtfj.image">Image</a> getImage​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> imageFile, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">File</a> metadata) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Creates a new <code>Image</code> object based on the contents of <code>imageFile</code> and <code>metadata</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>imageFile</code> - a file with image information, typically a core file</dd> |
| <dd><code>metadata</code> - an (implementation-defined) file with additional image information (or null if not required)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of <code>Image</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io" class="externalLink">IOException</a></code> - if there's a problem reading either of the specified files</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" target="_blank" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if <code>imageFile</code> is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDTFJMajorVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDTFJMajorVersion</h4> |
| <pre class="methodSignature">int getDTFJMajorVersion()</pre> |
| <div class="block">Fetch the DTFJ major version number.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an integer corresponding to the DTFJ API major version number</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDTFJMinorVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDTFJMinorVersion</h4> |
| <pre class="methodSignature">int getDTFJMinorVersion()</pre> |
| <div class="block">Fetch the DTFJ minor version number.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an integer corresponding to the DTFJ API minor version number</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDTFJModificationLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDTFJModificationLevel</h4> |
| <pre class="methodSignature">int getDTFJModificationLevel()</pre> |
| <div class="block">Fetch the DTFJ modification level.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an integer corresponding to the DTFJ API modification level</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>SDK 6.0 SR1 (DTFJ version 1.2)</dd> |
| </dl> |
| </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/ImageFactory.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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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 documentation.</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, 2020, IBM Corp. and others.</small></p> |
| </footer> |
| </body> |
| </html> |