Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk11 / openj9.dtfj / com / ibm / dtfj / image / Image.html
blob: 032a0511c9caa9ad4b76eb286e9a22d31fed3027 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Image (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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">
<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.5.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="Image (OpenJ9 JDK 11)";
}
}
catch(err) {
}
//-->
var data = {"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";
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/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-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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="../../../../module-summary.html">openj9.dtfj</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.ibm.dtfj.image</a></div>
<h2 title="Interface Image" class="title">Interface Image</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="javacore/JCReleasingImage.html" title="interface in com.ibm.dtfj.image.javacore">JCReleasingImage</a></code>, <code><a href="../utils/ManagedImage.html" title="interface in com.ibm.dtfj.utils">ManagedImage</a></code>, <code><a href="j9/ReleasingImage.html" title="interface in com.ibm.dtfj.image.j9">ReleasingImage</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../java/diagnostics/utils/DTFJImageBean.html" title="class in com.ibm.java.diagnostics.utils">DTFJImageBean</a></code>, <code><a href="j9/Image.html" title="class in com.ibm.dtfj.image.j9">Image</a></code>, <code><a href="../../j9ddr/view/dtfj/image/J9DDRImage.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRImage</a></code>, <code><a href="javacore/JCImage.html" title="class in com.ibm.dtfj.image.javacore">JCImage</a></code>, <code><a href="../phd/PHDImage.html" title="class in com.ibm.dtfj.phd">PHDImage</a></code></dd>
</dl>
<hr>
<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 =========== -->
<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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAddressSpaces()">getAddressSpaces</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreationTime()">getCreationTime</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreationTimeNanos()">getCreationTimeNanos</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHostName()">getHostName</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstalledMemory()">getInstalledMemory</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIPAddresses()">getIPAddresses</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProcessorCount()">getProcessorCount</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProcessorSubType()">getProcessorSubType</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProcessorType()">getProcessorType</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Properties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperties()">getProperties</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink" target="_blank">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSource()">getSource</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSystemSubType()">getSystemSubType</a></span>()</code></th>
<td class="colLast">
<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/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSystemType()">getSystemType</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTruncated()">isTruncated</a></span>()</code></th>
<td class="colLast">
<div class="block">Is this image truncated (i.e. incomplete)?</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getAddressSpaces()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddressSpaces</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;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="ImageAddressSpace.html" title="interface in com.ibm.dtfj.image"><code>ImageAddressSpace</code></a>,
<a href="CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd>
</dl>
</li>
</ul>
<a id="getProcessorType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessorType</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getProcessorType()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="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="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="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 id="getProcessorSubType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessorSubType</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getProcessorSubType()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="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="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd>
</dl>
</li>
</ul>
<a id="getProcessorCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessorCount</h4>
<pre class="methodSignature">int&nbsp;getProcessorCount()
throws <a href="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="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the information cannot be provided</dd>
</dl>
</li>
</ul>
<a id="getSystemType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemType</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getSystemType()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="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="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="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 id="getSystemSubType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemSubType</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getSystemSubType()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="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="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
<dd><code><a href="CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd>
</dl>
</li>
</ul>
<a id="getInstalledMemory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstalledMemory</h4>
<pre class="methodSignature">long&nbsp;getInstalledMemory()
throws <a href="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="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code> - if the information cannot be provided</dd>
</dl>
</li>
</ul>
<a id="getCreationTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationTime</h4>
<pre class="methodSignature">long&nbsp;getCreationTime()
throws <a href="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="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd>
</dl>
</li>
</ul>
<a id="getHostName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHostName</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getHostName()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="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="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="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 id="getIPAddresses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIPAddresses</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&nbsp;getIPAddresses()
throws <a href="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="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/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html?is-external=true" title="class or interface in java.net" class="externalLink" target="_blank"><code>InetAddress</code></a>,
<a href="CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">void&nbsp;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 id="getProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Properties</a>&nbsp;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 id="getSource()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink" target="_blank">URI</a>&nbsp;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 id="getCreationTimeNanos()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationTimeNanos</h4>
<pre class="methodSignature">long&nbsp;getCreationTimeNanos()
throws <a href="DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>,
<a href="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="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="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 id="isTruncated()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isTruncated</h4>
<pre class="methodSignature">default&nbsp;boolean&nbsp;isTruncated()</pre>
<div class="block">Is this image truncated (i.e. incomplete)?</div>
</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/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-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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</body>
</html>