| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Image (Diagnostic Tool Framework for Java&trade;)</title> |
| <meta name="keywords" content="com.ibm.dtfj.image.Image interface"> |
| <meta name="keywords" content="getAddressSpaces()"> |
| <meta name="keywords" content="getProcessorType()"> |
| <meta name="keywords" content="getProcessorSubType()"> |
| <meta name="keywords" content="getProcessorCount()"> |
| <meta name="keywords" content="getSystemType()"> |
| <meta name="keywords" content="getSystemSubType()"> |
| <meta name="keywords" content="getInstalledMemory()"> |
| <meta name="keywords" content="getCreationTime()"> |
| <meta name="keywords" content="getHostName()"> |
| <meta name="keywords" content="getIPAddresses()"> |
| <meta name="keywords" content="close()"> |
| <meta name="keywords" content="getProperties()"> |
| <meta name="keywords" content="getSource()"> |
| <meta name="keywords" content="getCreationTimeNanos()"> |
| <meta name="keywords" content="isTruncated()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Image (Diagnostic Tool Framework for Java™)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Image.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-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>Diagnostic Tool Framework for Java™</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/ibm/dtfj/image/DTFJException.html" title="class in com.ibm.dtfj.image"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/ibm/dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/dtfj/image/Image.html" target="_top">Frames</a></li> |
| <li><a href="Image.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.ibm.dtfj.image</div> |
| <h2 title="Interface Image" class="title">Interface Image</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Image</span></pre> |
| <div class="block"><p>Represents an entire operating system image (for example, a core file).</p> |
| |
| <p>There are methods for accessing information about the architecture |
| of the machine on which the image was running - hardware and |
| operating system. The major feature, however, is the ability to |
| iterate over the Address Spaces contained within the image.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#close--">close</a></span>()</code> |
| <div class="block">Close this image and any associated resources.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getAddressSpaces--">getAddressSpaces</a></span>()</code> |
| <div class="block">Get the set of address spaces within the image - typically one but may be more on some |
| systems such as Z/OS.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getCreationTime--">getCreationTime</a></span>()</code> |
| <div class="block">Get the time when the image was created</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getCreationTimeNanos--">getCreationTimeNanos</a></span>()</code> |
| <div class="block">Get the value of the JVM's high-resolution timer when the image was created.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getHostName--">getHostName</a></span>()</code> |
| <div class="block">Get the host name of the system where the image was running.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getInstalledMemory--">getInstalledMemory</a></span>()</code> |
| <div class="block">Get the amount of physical memory (in bytes) installed in the system on which |
| the image was running.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getIPAddresses--">getIPAddresses</a></span>()</code> |
| <div class="block">The set of IP addresses (as InetAddresses) which the system running the image possessed.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getProcessorCount--">getProcessorCount</a></span>()</code> |
| <div class="block">Get the number of CPUs running in the system on which the image was running.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getProcessorSubType--">getProcessorSubType</a></span>()</code> |
| <div class="block">Get the precise model of the CPU.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getProcessorType--">getProcessorType</a></span>()</code> |
| <div class="block">Get the family name for the processor on which the image was |
| running.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" target="_blank" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">Gets the OS specific properties for this image.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" target="_blank" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getSource--">getSource</a></span>()</code> |
| <div class="block">A unique identifier for the source of this image</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getSystemSubType--">getSystemSubType</a></span>()</code> |
| <div class="block">Get the detailed name of the operating system.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#getSystemType--">getSystemType</a></span>()</code> |
| <div class="block">Get the family name for the operating system.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/image/Image.html#isTruncated--">isTruncated</a></span>()</code> |
| <div class="block">Is this image truncated (i.e.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAddressSpaces--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAddressSpaces</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getAddressSpaces()</pre> |
| <div class="block">Get the set of address spaces within the image - typically one but may be more on some |
| systems such as Z/OS.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iterator which iterates over all of the address spaces |
| described by this Image</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../com/ibm/dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image"><code>ImageAddressSpace</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProcessorType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProcessorType</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getProcessorType() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the family name for the processor on which the image was |
| running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the family name for the processor on which the image was |
| running. This corresponds to the value you would find in the |
| "os.arch" System property.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if this data cannot be inferred from this core type</dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if expected data cannot be read from the core</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProcessorSubType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProcessorSubType</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getProcessorSubType() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the precise model of the CPU.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the precise model of the CPU (note that this can be an empty string but not null). |
| <br> |
| e.g. getProcessorType() will return "x86" where getProcessorSubType() may return "Pentium IV step 4" |
| <p> |
| Note that this value is platform and implementation dependent.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProcessorCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProcessorCount</h4> |
| <pre>int getProcessorCount() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre> |
| <div class="block">Get the number of CPUs running in the system on which the image was running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of CPUs running in the system on which the |
| image was running</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the information cannot be provided</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSystemType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSystemType</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getSystemType() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the family name for the operating system.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the family name for the operating system. This should be the same value |
| that would be returned for the "os.name" system property</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if this data cannot be inferred from this core type</dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if expected data cannot be read from the core</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSystemSubType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSystemSubType</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getSystemSubType() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the detailed name of the operating system.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the detailed name of the operating system, or an empty string |
| if this information is not available (null will never be returned). This should be |
| the same value that would be returned for the "os.version" system property</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstalledMemory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstalledMemory</h4> |
| <pre>long getInstalledMemory() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre> |
| <div class="block">Get the amount of physical memory (in bytes) installed in the system on which |
| the image was running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the amount of physical memory installed in the system on which |
| the image was running. The return value is specified in bytes.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the information cannot be provided</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCreationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreationTime</h4> |
| <pre>long getCreationTime() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre> |
| <div class="block">Get the time when the image was created</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the image creation time in milliseconds since 1970</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHostName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getHostName() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the host name of the system where the image was running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The host name of the system where the image was running. This string will |
| be non-null and non-empty</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - If the image did not provide this information (would happen |
| if the system did not know its host name or if the image predated this feature).</dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIPAddresses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIPAddresses</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getIPAddresses() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></pre> |
| <div class="block">The set of IP addresses (as InetAddresses) which the system running the image possessed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An Iterator over the IP addresses (as InetAddresses) which the system running |
| the image possessed. The iterator will be non-null (but can be empty if the host is |
| known to have no IP addresses).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - If the image did not provide this information (would happen |
| if the system failed to look them up or if the image pre-dated this feature).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" target="_blank" title="class or interface in java.net"><code>InetAddress</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block"><p>Close this image and any associated resources.</p> |
| |
| <p>Some kinds of Image require the generation of temporary resources, for example temporary files created |
| when reading core files and libraries from .zip archives. Ordinarily, these resources are deleted at JVM shutdown, |
| but DTFJ applications may want to free them earlier. This method should only be called when the Image is no |
| longer needed. After this method has been called, any objects associated with the image will be in an invalid state.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.4</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" target="_blank" title="class or interface in java.util">Properties</a> getProperties()</pre> |
| <div class="block">Gets the OS specific properties for this image.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of OS specific properties</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSource--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSource</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" target="_blank" title="class or interface in java.net">URI</a> getSource()</pre> |
| <div class="block">A unique identifier for the source of this image</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>URI for this image or null if this was not used when the image was created.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.10</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCreationTimeNanos--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreationTimeNanos</h4> |
| <pre>long getCreationTimeNanos() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the value of the JVM's high-resolution timer when the image was created.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the high-resolution timer, in nanoseconds</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the image creation time is not available</dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the image creation time is corrupted</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.12</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTruncated--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isTruncated</h4> |
| <pre>default boolean isTruncated()</pre> |
| <div class="block">Is this image truncated (i.e. incomplete)?</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Image.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-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>Diagnostic Tool Framework for Java™</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/ibm/dtfj/image/DTFJException.html" title="class in com.ibm.dtfj.image"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/ibm/dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/dtfj/image/Image.html" target="_top">Frames</a></li> |
| <li><a href="Image.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright © 2004, 2021, IBM Corp. and others.</small></p> |
| </body> |
| </html> |