Google Git
Sign in
eclipse / www.eclipse.org / openj9 / docs / bad2f0a456181a4a2e06615016bd4e1590b9f7a5 / . / api / jdk16 / openj9.dtfj / com / ibm / java / diagnostics / utils / Context.html
blob: 1c1b6e6b90c5925118baf032be24c22b58e47374 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>Context (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.dtfj, package: com.ibm.java.diagnostics.utils, class: Context">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.java.diagnostics.utils.Context class">
<meta name="keywords" content="globalCommands">
<meta name="keywords" content="commands">
<meta name="keywords" content="lastExecutedCommand">
<meta name="keywords" content="lastException">
<meta name="keywords" content="logger">
<meta name="keywords" content="loader">
<meta name="keywords" content="getPluginManager()">
<meta name="keywords" content="isCommandRecognised()">
<meta name="keywords" content="execute()">
<meta name="keywords" content="getCommandNames()">
<meta name="keywords" content="getCommands()">
<meta name="keywords" content="addGlobalCommandsToContext()">
<meta name="keywords" content="getLastExecutedCommand()">
<meta name="keywords" content="getLastCommandException()">
<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/Context.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><a href="#field.detail">Field</a>&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.dtfj</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.java.diagnostics.utils</a></div>
<h1 title="Class Context" class="title">Class Context</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">com.ibm.java.diagnostics.utils.Context</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="DTFJContext.html" title="class in com.ibm.java.diagnostics.utils">DTFJContext</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Context</span>
<span class="extends-implements">extends <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>
implements <a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></span></div>
<div class="block">A context represents the environment within which a command is executing.
This abstract class provides common functionality which is required by all
types of context.</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>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link" target="_blank">ArrayList</a>&lt;<a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a>&gt;</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#commands">commands</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link" target="_blank">ArrayList</a>&lt;<a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#globalCommands">globalCommands</a></span></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link" target="_blank">Exception</a></code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#lastException">lastException</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected <a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a></code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#lastExecutedCommand">lastExecutedCommand</a></span></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="plugins/PluginManager.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginManager</a></code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#loader">loader</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.logging/java/util/logging/Logger.html" title="class or interface in java.util.logging" class="external-link" target="_blank">Logger</a></code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#logger">logger</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Shared logger for all commands to write to</div>
</div>
</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()">Context</a></span>()</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>protected 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="#addGlobalCommandsToContext()">addGlobalCommandsToContext</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">This adds the list of global commands which are applicable for any
context to this specific context instance</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="commands/CommandParser.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandParser</a>&nbsp;commandParser,
<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;line,
<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;command,
<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/util/Vector.html" title="class or interface in java.util" class="external-link" target="_blank">Vector</a>&lt;<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>&gt;</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="#getCommandNames()">getCommandNames</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">List of all the command names that are available within this context</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/util/List.html" title="class or interface in java.util" class="external-link" target="_blank">List</a>&lt;<a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a>&gt;</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="#getCommands()">getCommands</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">Returns a list of commands which are available for this context</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/Exception.html" title="class or interface in java.lang" class="external-link" target="_blank">Exception</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="#getLastCommandException()">getLastCommandException</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">Provides access to any uncaught exceptions thrown when the last command was executed.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</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="#getLastExecutedCommand()">getLastExecutedCommand</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">The last command which was successfully executed by the context.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="plugins/PluginManager.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginManager</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="#getPluginManager()">getPluginManager</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</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="#isCommandRecognised(java.lang.String)">isCommandRecognised</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;command)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Allows to check if the given command will be executed (i.e. if there is a command that will accept the string)
without actually executing it, avoiding error messages etc.</div>
</div>
</div>
</div>
</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="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></h3>
<code><a href="IContext.html#getPluginClassloader()">getPluginClassloader</a>, <a href="IContext.html#getProperties()">getProperties</a>, <a href="IContext.html#refresh()">refresh</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="globalCommands">
<h3>globalCommands</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link" target="_blank">ArrayList</a>&lt;<a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a>&gt;</span>&nbsp;<span class="element-name">globalCommands</span></div>
</section>
</li>
<li>
<section class="detail" id="commands">
<h3>commands</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link" target="_blank">ArrayList</a>&lt;<a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a>&gt;</span>&nbsp;<span class="element-name">commands</span></div>
</section>
</li>
<li>
<section class="detail" id="lastExecutedCommand">
<h3>lastExecutedCommand</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a></span>&nbsp;<span class="element-name">lastExecutedCommand</span></div>
</section>
</li>
<li>
<section class="detail" id="lastException">
<h3>lastException</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link" target="_blank">Exception</a></span>&nbsp;<span class="element-name">lastException</span></div>
</section>
</li>
<li>
<section class="detail" id="logger">
<h3>logger</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.logging/java/util/logging/Logger.html" title="class or interface in java.util.logging" class="external-link" target="_blank">Logger</a></span>&nbsp;<span class="element-name">logger</span></div>
<div class="block">Shared logger for all commands to write to</div>
</section>
</li>
<li>
<section class="detail" id="loader">
<h3>loader</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="plugins/PluginManager.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginManager</a></span>&nbsp;<span class="element-name">loader</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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;()">
<h3>Context</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Context</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="getPluginManager()">
<h3>getPluginManager</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="plugins/PluginManager.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginManager</a></span>&nbsp;<span class="element-name">getPluginManager</span>()</div>
</section>
</li>
<li>
<section class="detail" id="isCommandRecognised(java.lang.String)">
<h3>isCommandRecognised</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isCommandRecognised</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;command)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IContext.html#isCommandRecognised(java.lang.String)">IContext</a></code></span></div>
<div class="block">Allows to check if the given command will be executed (i.e. if there is a command that will accept the string)
without actually executing it, avoiding error messages etc.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IContext.html#isCommandRecognised(java.lang.String)">isCommandRecognised</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Parameters:</dt>
<dd><code>command</code> - - just the actual command WITHOUT ARGUMENTS</dd>
<dt>Returns:</dt>
</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;command,
<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="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="IContext.html#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Parameters:</dt>
<dd><code>command</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="commands/CommandParser.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandParser</a>&nbsp;commandParser,
<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="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="IContext.html#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></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;line,
<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="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="IContext.html#execute(java.lang.String,java.io.PrintStream)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Parameters:</dt>
<dd><code>line</code> - line to execute</dd>
<dd><code>out</code> - where to write the output to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCommandNames()">
<h3>getCommandNames</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/util/Vector.html" title="class or interface in java.util" class="external-link" target="_blank">Vector</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">getCommandNames</span>()</div>
<div class="block">List of all the command names that are available within this context</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>list of names</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCommands()">
<h3>getCommands</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/util/List.html" title="class or interface in java.util" class="external-link" target="_blank">List</a>&lt;<a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a>&gt;</span>&nbsp;<span class="element-name">getCommands</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IContext.html#getCommands()">IContext</a></code></span></div>
<div class="block">Returns a list of commands which are available for this context</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IContext.html#getCommands()">getCommands</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Returns:</dt>
</dl>
</section>
</li>
<li>
<section class="detail" id="addGlobalCommandsToContext()">
<h3>addGlobalCommandsToContext</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addGlobalCommandsToContext</span>()</div>
<div class="block">This adds the list of global commands which are applicable for any
context to this specific context instance</div>
</section>
</li>
<li>
<section class="detail" id="getLastExecutedCommand()">
<h3>getLastExecutedCommand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="commands/ICommand.html" title="interface in com.ibm.java.diagnostics.utils.commands">ICommand</a></span>&nbsp;<span class="element-name">getLastExecutedCommand</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IContext.html#getLastExecutedCommand()">IContext</a></code></span></div>
<div class="block">The last command which was successfully executed by the context.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IContext.html#getLastExecutedCommand()">getLastExecutedCommand</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Returns:</dt>
<dd>the command or null if none have been executed or the command threw an exception</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLastCommandException()">
<h3>getLastCommandException</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/Exception.html" title="class or interface in java.lang" class="external-link" target="_blank">Exception</a></span>&nbsp;<span class="element-name">getLastCommandException</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IContext.html#getLastCommandException()">IContext</a></code></span></div>
<div class="block">Provides access to any uncaught exceptions thrown when the last command was executed.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IContext.html#getLastCommandException()">getLastCommandException</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
<dt>Returns:</dt>
<dd>the exception or null of no uncaught exceptions were thrown</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/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>