| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>Session (OpenJ9 JDK 18)</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: Session"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.jvm.dtfjview.Session class"> |
| <meta name="keywords" content="LOGGER_PROPERTY"> |
| <meta name="keywords" content="prompt"> |
| <meta name="keywords" content="getInstance()"> |
| <meta name="keywords" content="getOutputManager()"> |
| <meta name="keywords" content="getCharset()"> |
| <meta name="keywords" content="getCurrentContext()"> |
| <meta name="keywords" content="getContextManager()"> |
| <meta name="keywords" content="setContext()"> |
| <meta name="keywords" content="showContexts()"> |
| <meta name="keywords" content="findAndSetContextWithJVM()"> |
| <meta name="keywords" content="run()"> |
| <meta name="keywords" content="execute()"> |
| <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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button> |
| <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 18</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/Session.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li><a href="#field-summary">Field</a></li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li><a href="#field-detail">Field</a></li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">openj9.dtfjview</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.jvm.dtfjview</a></div> |
| <h1 title="Class Session" class="title">Class Session</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.jvm.dtfjview.Session</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Session</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a> |
| implements <a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#LOGGER_PROPERTY" class="member-name-link">LOGGER_PROPERTY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#prompt" class="member-name-link">prompt</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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 method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(java.lang.String)" class="member-name-link">execute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> line)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Executes the supplied command.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(java.lang.String,java.io.PrintStream)" class="member-name-link">execute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> line, |
| <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> redirector)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Execute a command line.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findAndSetContextWithJVM()" class="member-name-link">findAndSetContextWithJVM</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Convenience method which instructs the session to search through all the |
| available contexts and set the current one to the first |
| one it finds with a non-corrupt DTFJ JavaRuntime in it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCharset()" class="member-name-link">getCharset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="spi/ISessionContextManager.html" title="interface in com.ibm.jvm.dtfjview.spi">ISessionContextManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContextManager()" class="member-name-link">getContextManager</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the manager which is managing this context within this session.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentContext()" class="member-name-link">getCurrentContext</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The currently selected context against which commands will be executed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.String%5B%5D)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[] args)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Factory method for creating new sessions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="spi/IOutputManager.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOutputManager()" class="member-name-link">getOutputManager</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The instance which is managing all registered output channels.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setContext(int)" class="member-name-link">setContext</a><wbr>(int id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the context within which subsequent commands will be executed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setContext(com.ibm.jvm.dtfjview.spi.ICombinedContext)" class="member-name-link">setContext</a><wbr>(<a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a> switchTo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the context within which subsequent commands will be executed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#showContexts(boolean)" class="member-name-link">showContexts</a><wbr>(boolean shortFormat)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Display the contexts which are present in the core file currently being analysed.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOGGER_PROPERTY"> |
| <h3>LOGGER_PROPERTY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">LOGGER_PROPERTY</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#com.ibm.jvm.dtfjview.Session.LOGGER_PROPERTY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prompt"> |
| <h3>prompt</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">prompt</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="getInstance(java.lang.String[])"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[] args)</span></div> |
| <div class="block">Factory method for creating new sessions.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>args</code> - any session arguments</dd> |
| <dt>Returns:</dt> |
| <dd>the session</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutputManager()"> |
| <h3>getOutputManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="spi/IOutputManager.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputManager</a></span> <span class="element-name">getOutputManager</span>()</div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#getOutputManager()">ISession</a></code></span></div> |
| <div class="block">The instance which is managing all registered output channels.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#getOutputManager()">getOutputManager</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the manager</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCharset()"> |
| <h3>getCharset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">getCharset</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCurrentContext()"> |
| <h3>getCurrentContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a></span> <span class="element-name">getCurrentContext</span>()</div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#getCurrentContext()">ISession</a></code></span></div> |
| <div class="block">The currently selected context against which commands will be executed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#getCurrentContext()">getCurrentContext</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the current context, it may or may not have DDR interactive support</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContextManager()"> |
| <h3>getContextManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="spi/ISessionContextManager.html" title="interface in com.ibm.jvm.dtfjview.spi">ISessionContextManager</a></span> <span class="element-name">getContextManager</span>()</div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#getContextManager()">ISession</a></code></span></div> |
| <div class="block">Get the manager which is managing this context within this session.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#getContextManager()">getContextManager</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the context manager</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setContext(int)"> |
| <h3>setContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setContext</span><wbr><span class="parameters">(int id)</span> |
| throws <span class="exceptions"><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/commands/CommandException.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandException</a></span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#setContext(int)">ISession</a></code></span></div> |
| <div class="block">Set the context within which subsequent commands will be executed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#setContext(int)">setContext</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - context ID</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/commands/CommandException.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandException</a></code> - thrown if an invalid context ID is specified</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setContext(com.ibm.jvm.dtfjview.spi.ICombinedContext)"> |
| <h3>setContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setContext</span><wbr><span class="parameters">(<a href="spi/ICombinedContext.html" title="interface in com.ibm.jvm.dtfjview.spi">ICombinedContext</a> switchTo)</span> |
| throws <span class="exceptions"><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/commands/CommandException.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandException</a></span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#setContext(com.ibm.jvm.dtfjview.spi.ICombinedContext)">ISession</a></code></span></div> |
| <div class="block">Set the context within which subsequent commands will be executed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#setContext(com.ibm.jvm.dtfjview.spi.ICombinedContext)">setContext</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>switchTo</code> - the context to switch to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../../../openj9.dtfj/com/ibm/java/diagnostics/utils/commands/CommandException.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandException</a></code> - thrown if the switch fails. The underlying reason will be in the logs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="showContexts(boolean)"> |
| <h3>showContexts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">showContexts</span><wbr><span class="parameters">(boolean shortFormat)</span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#showContexts(boolean)">ISession</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/ISession.html#showContexts(boolean)">showContexts</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Parameters:</dt> |
| <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="findAndSetContextWithJVM()"> |
| <h3>findAndSetContextWithJVM</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">findAndSetContextWithJVM</span>()</div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#findAndSetContextWithJVM()">ISession</a></code></span></div> |
| <div class="block">Convenience method which instructs the session to search through all the |
| available contexts and set the current one to the first |
| one it finds with a non-corrupt DTFJ JavaRuntime in it.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#findAndSetContextWithJVM()">findAndSetContextWithJVM</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="run()"> |
| <h3>run</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span>()</div> |
| </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> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> line, |
| <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> redirector)</span></div> |
| <div class="block">Execute a command line. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>line</code> - The command line to be executed.</dd> |
| <dd><code>redirector</code> - The PrintStream.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(java.lang.String)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> line)</span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="spi/ISession.html#execute(java.lang.String)">ISession</a></code></span></div> |
| <div class="block">Executes the supplied command. Output will be written via the IOutputManager to |
| all registered channels.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="spi/ISession.html#execute(java.lang.String)">execute</a></code> in interface <code><a href="spi/ISession.html" title="interface in com.ibm.jvm.dtfjview.spi">ISession</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>line</code> - the command and any parameters to execute.</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 © 1998, 2022 IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |