| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>DTFJContext (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: DTFJContext"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.java.diagnostics.utils.DTFJContext class"> |
| <meta name="keywords" content="getProperties()"> |
| <meta name="keywords" content="getMajorVersion()"> |
| <meta name="keywords" content="getMinorVersion()"> |
| <meta name="keywords" content="getAddressSpace()"> |
| <meta name="keywords" content="getRuntime()"> |
| <meta name="keywords" content="getProcess()"> |
| <meta name="keywords" content="refresh()"> |
| <meta name="keywords" content="getImage()"> |
| <meta name="keywords" content="hasPropertyBeenSet()"> |
| <meta name="keywords" content="getPlugins()"> |
| <meta name="keywords" content="getPluginFailures()"> |
| <meta name="keywords" content="loadPlugins()"> |
| <meta name="keywords" content="getPluginClassloader()"> |
| <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/DTFJContext.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> <a href="../../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.java.diagnostics.utils</a></div> |
| <h1 title="Class DTFJContext" class="title">Class DTFJContext</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="Context.html" title="class in com.ibm.java.diagnostics.utils">com.ibm.java.diagnostics.utils.Context</a> |
| <div class="inheritance">com.ibm.java.diagnostics.utils.DTFJContext</div> |
| </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>, <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code>, <code><a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../../../../../../openj9.dtfjview/com/ibm/jvm/dtfjview/CombinedContext.html" title="class in com.ibm.jvm.dtfjview">CombinedContext</a></code>, <code><a href="EmptyDTFJContext.html" title="class in com.ibm.java.diagnostics.utils">EmptyDTFJContext</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DTFJContext</span> |
| <span class="extends-implements">extends <a href="Context.html" title="class in com.ibm.java.diagnostics.utils">Context</a> |
| implements <a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a>, <a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></span></div> |
| <div class="block">A DTFJ context within which a DTFJ command executes</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 com.ibm.java.diagnostics.utils.<a href="Context.html" title="class in com.ibm.java.diagnostics.utils">Context</a></h3> |
| <code><a href="Context.html#commands">commands</a>, <a href="Context.html#globalCommands">globalCommands</a>, <a href="Context.html#lastException">lastException</a>, <a href="Context.html#lastExecutedCommand">lastExecutedCommand</a>, <a href="Context.html#loader">loader</a>, <a href="Context.html#logger">logger</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)">DTFJContext</a></span>​(int major, |
| int minor, |
| <a href="../../../dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a> image, |
| <a href="../../../dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a> space, |
| <a href="../../../dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a> proc, |
| <a href="../../../dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a> rt)</code></div> |
| <div class="col-last even-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-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><a href="../../../dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</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="#getAddressSpace()">getAddressSpace</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">The address space for 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="DTFJImageBean.html" title="class in com.ibm.java.diagnostics.utils">DTFJImageBean</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="#getImage()">getImage</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">A simple Java bean which allows access to the data on DTFJ image interface.</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="#getMajorVersion()">getMajorVersion</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">The major version of the DTFJ API for this context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</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="#getMinorVersion()">getMinorVersion</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 minor version of the DTFJ API 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="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</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="#getPluginClassloader()">getPluginClassloader</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">Gets the classloader which has been used to add plugins.</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/ArrayList.html" title="class or interface in java.util" class="external-link" target="_blank">ArrayList</a><<a href="plugins/PluginConfig.html" title="class in com.ibm.java.diagnostics.utils.plugins">PluginConfig</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="#getPluginFailures()">getPluginFailures</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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/ArrayList.html" title="class or interface in java.util" class="external-link" target="_blank">ArrayList</a><<a href="plugins/PluginConfig.html" title="class in com.ibm.java.diagnostics.utils.plugins">PluginConfig</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="#getPlugins()">getPlugins</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../../../dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</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="#getProcess()">getProcess</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 process 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/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</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="#getProperties()">getProperties</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 set of defined properties.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../../../dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</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="#getRuntime()">getRuntime</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 Java runtime for this context.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#hasPropertyBeenSet(java.lang.String)">hasPropertyBeenSet</a></span>​(<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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Used to determine if a property has been set in the context property |
| bag, and that the value of that property is TRUE</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="#loadPlugins()">loadPlugins</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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="#refresh()">refresh</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">Refresh this context.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.Context">Methods declared in class com.ibm.java.diagnostics.utils.<a href="Context.html" title="class in com.ibm.java.diagnostics.utils">Context</a></h3> |
| <code><a href="Context.html#addGlobalCommandsToContext()">addGlobalCommandsToContext</a>, <a href="Context.html#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">execute</a>, <a href="Context.html#execute(java.lang.String,java.io.PrintStream)">execute</a>, <a href="Context.html#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">execute</a>, <a href="Context.html#getCommandNames()">getCommandNames</a>, <a href="Context.html#getCommands()">getCommands</a>, <a href="Context.html#getLastCommandException()">getLastCommandException</a>, <a href="Context.html#getLastExecutedCommand()">getLastExecutedCommand</a>, <a href="Context.html#getPluginManager()">getPluginManager</a>, <a href="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 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 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#execute(com.ibm.java.diagnostics.utils.commands.CommandParser,java.io.PrintStream)">execute</a>, <a href="IContext.html#execute(java.lang.String,java.io.PrintStream)">execute</a>, <a href="IContext.html#execute(java.lang.String,java.lang.String%5B%5D,java.io.PrintStream)">execute</a>, <a href="IContext.html#getCommands()">getCommands</a>, <a href="IContext.html#getLastCommandException()">getLastCommandException</a>, <a href="IContext.html#getLastExecutedCommand()">getLastExecutedCommand</a>, <a href="IContext.html#isCommandRecognised(java.lang.String)">isCommandRecognised</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="<init>(int,int,com.ibm.dtfj.image.Image,com.ibm.dtfj.image.ImageAddressSpace,com.ibm.dtfj.image.ImageProcess,com.ibm.dtfj.java.JavaRuntime)"> |
| <h3>DTFJContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DTFJContext</span>​<span class="parameters">(int major, |
| int minor, |
| <a href="../../../dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a> image, |
| <a href="../../../dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a> space, |
| <a href="../../../dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a> proc, |
| <a href="../../../dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a> rt)</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="getProperties()"> |
| <h3>getProperties</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a></span> <span class="element-name">getProperties</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IContext.html#getProperties()">IContext</a></code></span></div> |
| <div class="block">A set of defined properties. This typically includes information not on the DTFJ API, but may be useful for plugin processing e.g. a logging level. |
| Tools such as jdmpview which provide not only the execution harness but some in-built commands |
| use properties to pass information to commands.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IContext.html#getProperties()">getProperties</a></code> in interface <code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>properties that have currently been set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMajorVersion()"> |
| <h3>getMajorVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMajorVersion</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IDTFJContext.html#getMajorVersion()">IDTFJContext</a></code></span></div> |
| <div class="block">The major version of the DTFJ API for this context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#getMajorVersion()">getMajorVersion</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>major version number</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinorVersion()"> |
| <h3>getMinorVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMinorVersion</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IDTFJContext.html#getMinorVersion()">IDTFJContext</a></code></span></div> |
| <div class="block">The minor version of the DTFJ API for this context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#getMinorVersion()">getMinorVersion</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>minor version number</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAddressSpace()"> |
| <h3>getAddressSpace</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a></span> <span class="element-name">getAddressSpace</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IDTFJContext.html#getAddressSpace()">IDTFJContext</a></code></span></div> |
| <div class="block">The address space for this context. This may or may not |
| contain any processes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#getAddressSpace()">getAddressSpace</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the image address space</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRuntime()"> |
| <h3>getRuntime</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a></span> <span class="element-name">getRuntime</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IDTFJContext.html#getRuntime()">IDTFJContext</a></code></span></div> |
| <div class="block">The Java runtime for this context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#getRuntime()">getRuntime</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the runtime or null if there is no runtime available</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProcess()"> |
| <h3>getProcess</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a></span> <span class="element-name">getProcess</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IDTFJContext.html#getProcess()">IDTFJContext</a></code></span></div> |
| <div class="block">The process for this context. A process may or may not |
| contain a Java runtime.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#getProcess()">getProcess</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="refresh()"> |
| <h3>refresh</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">refresh</span>()</div> |
| <div class="block">Refresh this context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IContext.html#refresh()">refresh</a></code> in interface <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="getImage()"> |
| <h3>getImage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DTFJImageBean.html" title="class in com.ibm.java.diagnostics.utils">DTFJImageBean</a></span> <span class="element-name">getImage</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IDTFJContext.html#getImage()">IDTFJContext</a></code></span></div> |
| <div class="block">A simple Java bean which allows access to the data on DTFJ image interface. |
| This removes the requirement to provide a command/plugin with a direct |
| reference to the Image.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#getImage()">getImage</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the bean</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasPropertyBeenSet(java.lang.String)"> |
| <h3>hasPropertyBeenSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasPropertyBeenSet</span>​<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> name)</span></div> |
| <div class="block">Used to determine if a property has been set in the context property |
| bag, and that the value of that property is TRUE</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IDTFJContext.html#hasPropertyBeenSet(java.lang.String)">hasPropertyBeenSet</a></code> in interface <code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - property name to check</dd> |
| <dt>Returns:</dt> |
| <dd>true if the property exists and Boolean.parseValue() returns true</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPlugins()"> |
| <h3>getPlugins</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<a href="plugins/PluginConfig.html" title="class in com.ibm.java.diagnostics.utils.plugins">PluginConfig</a>></span> <span class="element-name">getPlugins</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="plugins/PluginLoader.html#getPlugins()">getPlugins</a></code> in interface <code><a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPluginFailures()"> |
| <h3>getPluginFailures</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<a href="plugins/PluginConfig.html" title="class in com.ibm.java.diagnostics.utils.plugins">PluginConfig</a>></span> <span class="element-name">getPluginFailures</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="plugins/PluginLoader.html#getPluginFailures()">getPluginFailures</a></code> in interface <code><a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loadPlugins()"> |
| <h3>loadPlugins</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">loadPlugins</span>() |
| throws <span class="exceptions"><a href="commands/CommandException.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="plugins/PluginLoader.html#loadPlugins()">loadPlugins</a></code> in interface <code><a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="commands/CommandException.html" title="class in com.ibm.java.diagnostics.utils.commands">CommandException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPluginClassloader()"> |
| <h3>getPluginClassloader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></span> <span class="element-name">getPluginClassloader</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IContext.html#getPluginClassloader()">IContext</a></code></span></div> |
| <div class="block">Gets the classloader which has been used to add plugins. This is typically done |
| to add new plugins at runtime or refresh the existing list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IContext.html#getPluginClassloader()">getPluginClassloader</a></code> in interface <code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the classloader</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, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |