blob: e8814e9c89909a97dc21d049fc33deece877763c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>CombinedContext (OpenJ9 JDK 16)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: openj9.dtfjview, package: com.ibm.jvm.dtfjview, class: CombinedContext">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.jvm.dtfjview.CombinedContext class">
<meta name="keywords" content="getID()">
<meta name="keywords" content="setID()">
<meta name="keywords" content="execute()">
<meta name="keywords" content="startDDRInteractiveSession()">
<meta name="keywords" content="getDDRIObject()">
<meta name="keywords" content="getDDRStartupException()">
<meta name="keywords" content="displayContext()">
<meta name="keywords" content="setAsCurrent()">
<meta name="keywords" content="isDDRAvailable()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/CombinedContext.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">openj9.dtfjview</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.jvm.dtfjview</a></div>
<h1 title="Class CombinedContext" class="title">Class CombinedContext</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a>
<div class="inheritance"><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html" title="class in com.ibm.java.diagnostics.utils">com.ibm.java.diagnostics.utils.Context</a>
<div class="inheritance"><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html" title="class in com.ibm.java.diagnostics.utils">com.ibm.java.diagnostics.utils.DTFJContext</a>
<div class="inheritance">com.ibm.jvm.dtfjview.CombinedContext</div>
</div>
</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code>, <code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code>, <code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></code>, <code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CombinedContext</span>
<span class="extends-implements">extends <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html" title="class in com.ibm.java.diagnostics.utils">DTFJContext</a>
implements <a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></span></div>
<div class="block">Wrapper class that takes an existing DTFJ context and augments
it with a DDR interactive context if one exists.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields.inherited.from.class.com.ibm.java.diagnostics.utils.Context">Fields declared in class&nbsp;com.ibm.java.diagnostics.utils.<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html" title="class in com.ibm.java.diagnostics.utils">Context</a></h3>
<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#commands">commands</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#globalCommands">globalCommands</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#lastException">lastException</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#lastExecutedCommand">lastExecutedCommand</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#loader">loader</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(int,int,com.ibm.dtfj.image.Image,com.ibm.dtfj.image.ImageAddressSpace,com.ibm.dtfj.image.ImageProcess,com.ibm.dtfj.java.JavaRuntime,int)">CombinedContext</a></span>&#8203;(int&nbsp;major,
int&nbsp;minor,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a>&nbsp;image,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a>&nbsp;space,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a>&nbsp;proc,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a>&nbsp;rt,
int&nbsp;id)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#displayContext(com.ibm.jvm.dtfjview.spi.IOutputManager,boolean)">displayContext</a></span>&#8203;(<a href="spi/IOutputManager.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputManager</a>&nbsp;out,
boolean&nbsp;shortFormat)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Display the contexts which are present in the core file currently being analysed.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">execute</a></span>&#8203;(<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/commands/CommandParser.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandParser</a>&nbsp;command,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Execute the entered command line with the output sent to the supplied print stream.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#execute(java.lang.String,java.io.PrintStream)">execute</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;cmdline,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Execute the entered command line with the output sent to the supplied print stream.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">execute</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;cmdline,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]&nbsp;arguments,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Execute the entered command line with the output sent to the supplied print stream.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getDDRIObject()">getDDRIObject</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">A handle to the underlying DDR interactive session</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getDDRStartupException()">getDDRStartupException</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the exception which was thrown when trying to start a DDR interactive session.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getID()">getID</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Contexts have a unique positive numeric identifier within a session.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isDDRAvailable()">isDDRAvailable</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Flag to indicate if an associated DDR context is available as well as the DTFJ one.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setAsCurrent()">setAsCurrent</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Called when this context becomes the current context to allow
any initialisation to take place.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setID(int)">setID</a></span>&#8203;(int&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Sets the numeric ID for this context.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#startDDRInteractiveSession(com.ibm.dtfj.image.Image,java.io.PrintStream)">startDDRInteractiveSession</a></span>&#8203;(<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a>&nbsp;image,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Starts a DDR interactive session using the loaded image.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.DTFJContext">Methods declared in class&nbsp;com.ibm.java.diagnostics.utils.<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html" title="class in com.ibm.java.diagnostics.utils">DTFJContext</a></h3>
<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getAddressSpace()">getAddressSpace</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getImage()">getImage</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getMajorVersion()">getMajorVersion</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getMinorVersion()">getMinorVersion</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getPluginClassloader()">getPluginClassloader</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getPluginFailures()">getPluginFailures</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getPlugins()">getPlugins</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getProcess()">getProcess</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getProperties()">getProperties</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#getRuntime()">getRuntime</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#hasPropertyBeenSet(java.lang.String)">hasPropertyBeenSet</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#loadPlugins()">loadPlugins</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/DTFJContext.html#refresh()">refresh</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.Context">Methods declared in class&nbsp;com.ibm.java.diagnostics.utils.<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html" title="class in com.ibm.java.diagnostics.utils">Context</a></h3>
<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#addGlobalCommandsToContext()">addGlobalCommandsToContext</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">execute</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#execute(java.lang.String,java.io.PrintStream)">execute</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">execute</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#getCommandNames()">getCommandNames</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#getCommands()">getCommands</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#getLastCommandException()">getLastCommandException</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#getLastExecutedCommand()">getLastExecutedCommand</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#getPluginManager()">getPluginManager</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/Context.html#isCommandRecognised(java.lang.String)">isCommandRecognised</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.IContext">Methods declared in interface&nbsp;com.ibm.java.diagnostics.utils.<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></h3>
<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#getCommands()">getCommands</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#getLastCommandException()">getLastCommandException</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#getLastExecutedCommand()">getLastExecutedCommand</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#getPluginClassloader()">getPluginClassloader</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#getProperties()">getProperties</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#isCommandRecognised(java.lang.String)">isCommandRecognised</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#refresh()">refresh</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.IDTFJContext">Methods declared in interface&nbsp;com.ibm.java.diagnostics.utils.<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></h3>
<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#getAddressSpace()">getAddressSpace</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#getImage()">getImage</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#getMajorVersion()">getMajorVersion</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#getMinorVersion()">getMinorVersion</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#getProcess()">getProcess</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#getRuntime()">getRuntime</a>, <a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IDTFJContext.html#hasPropertyBeenSet(java.lang.String)">hasPropertyBeenSet</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(int,int,com.ibm.dtfj.image.Image,com.ibm.dtfj.image.ImageAddressSpace,com.ibm.dtfj.image.ImageProcess,com.ibm.dtfj.java.JavaRuntime,int)">
<h3>CombinedContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CombinedContext</span>&#8203;<span class="parameters">(int&nbsp;major,
int&nbsp;minor,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a>&nbsp;image,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a>&nbsp;space,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a>&nbsp;proc,
<a href="../../../../../openj9.dtfj/com/ibm/dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a>&nbsp;rt,
int&nbsp;id)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getID()">
<h3>getID</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getID</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#getID()">ICombinedContext</a></code></span></div>
<div class="block">Contexts have a unique positive numeric identifier within a session. This number always
increases if new contexts are created via the open command rather than attempting to re-use
any already used IDs.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#getID()">getID</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
<dt>Returns:</dt>
<dd>the ID for this context</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setID(int)">
<h3>setID</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setID</span>&#8203;<span class="parameters">(int&nbsp;id)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#setID(int)">ICombinedContext</a></code></span></div>
<div class="block">Sets the numeric ID for this context. This setter is provided so as to allow context creation
before assigning the ID. However once set it should not be changed. Later implementations may
enforce this.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#setID(int)">setID</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
<dt>Parameters:</dt>
<dd><code>id</code> - the context ID</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute(java.lang.String,java.lang.String[],java.io.PrintStream)">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;cmdline,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]&nbsp;arguments,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">IContext</a></code></span></div>
<div class="block">Execute the entered command line with the output sent to the supplied print stream.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Parameters:</dt>
<dd><code>cmdline</code> - line to execute</dd>
<dd><code>out</code> - where to write the output to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute(java.lang.String,java.io.PrintStream)">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;cmdline,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#execute(java.lang.String,java.io.PrintStream)">IContext</a></code></span></div>
<div class="block">Execute the entered command line with the output sent to the supplied print stream.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#execute(java.lang.String,java.io.PrintStream)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Parameters:</dt>
<dd><code>cmdline</code> - line to execute</dd>
<dd><code>out</code> - where to write the output to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>&#8203;<span class="parameters">(<a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/commands/CommandParser.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandParser</a>&nbsp;command,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">IContext</a></code></span></div>
<div class="block">Execute the entered command line with the output sent to the supplied print stream.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="startDDRInteractiveSession(com.ibm.dtfj.image.Image,java.io.PrintStream)">
<h3>startDDRInteractiveSession</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">startDDRInteractiveSession</span>&#8203;<span class="parameters">(<a href="../../../../../openj9.dtfj/com/ibm/dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a>&nbsp;image,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span></div>
<div class="block">Starts a DDR interactive session using the loaded image. If the core file is not DDR enabled
this is recorded and future pling commands will not be available. In order to get access to the
DDR classes it uses the Image classloader which, if the core file is DDR enabled, can see the
required classes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>image</code> - Image created from the core file</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDDRIObject()">
<h3>getDDRIObject</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span>&nbsp;<span class="element-name">getDDRIObject</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#getDDRIObject()">ICombinedContext</a></code></span></div>
<div class="block">A handle to the underlying DDR interactive session</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#getDDRIObject()">getDDRIObject</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
<dt>Returns:</dt>
<dd>a valid session or null if the core file is not DDR enabled</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDDRStartupException()">
<h3>getDDRStartupException</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a></span>&nbsp;<span class="element-name">getDDRStartupException</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#getDDRStartupException()">ICombinedContext</a></code></span></div>
<div class="block">Get the exception which was thrown when trying to start a DDR interactive session.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#getDDRStartupException()">getDDRStartupException</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
<dt>Returns:</dt>
<dd>the exception or null if the session started without error.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="displayContext(com.ibm.jvm.dtfjview.spi.IOutputManager,boolean)">
<h3>displayContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">displayContext</span>&#8203;<span class="parameters">(<a href="spi/IOutputManager.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputManager</a>&nbsp;out,
boolean&nbsp;shortFormat)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#displayContext(com.ibm.jvm.dtfjview.spi.IOutputManager,boolean)">ICombinedContext</a></code></span></div>
<div class="block">Display the contexts which are present in the core file currently being analysed.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#displayContext(com.ibm.jvm.dtfjview.spi.IOutputManager,boolean)">displayContext</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
<dd><code>shortFormat</code> - true for short format which just displays the first line of the java -version string</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAsCurrent()">
<h3>setAsCurrent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAsCurrent</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#setAsCurrent()">ICombinedContext</a></code></span></div>
<div class="block">Called when this context becomes the current context to allow
any initialisation to take place.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#setAsCurrent()">setAsCurrent</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isDDRAvailable()">
<h3>isDDRAvailable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDDRAvailable</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="spi/ICombinedContext.html#isDDRAvailable()">ICombinedContext</a></code></span></div>
<div class="block">Flag to indicate if an associated DDR context is available as well as the DTFJ one.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="spi/ICombinedContext.html#isDDRAvailable()">isDDRAvailable</a></code>&nbsp;in interface&nbsp;<code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></dd>
<dt>Returns:</dt>
<dd>true if DDR is available</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>