blob: 541b8f2b4d6cdd1e5d3d2e85bf13aada17443f60 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DTFJContext (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DTFJContext (OpenJ9 JDK 11)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.ibm.java.diagnostics.utils</a></div>
<h2 title="Class DTFJContext" class="title">Class DTFJContext</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="Context.html" title="class in com.ibm.java.diagnostics.utils">com.ibm.java.diagnostics.utils.Context</a></li>
<li>
<ul class="inheritance">
<li>com.ibm.java.diagnostics.utils.DTFJContext</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<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>
<pre>public class <span class="typeNameLabel">DTFJContext</span>
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></pre>
<div class="block">A DTFJ context within which a DTFJ command executes</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.ibm.java.diagnostics.utils.Context">
<!-- -->
</a>
<h3>Fields declared in class&nbsp;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></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><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>&#8203;(int&nbsp;major,
int&nbsp;minor,
<a href="../../../dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a>&nbsp;image,
<a href="../../../dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a>&nbsp;space,
<a href="../../../dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a>&nbsp;proc,
<a href="../../../dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a>&nbsp;rt)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPropertyBeenSet(java.lang.String)">hasPropertyBeenSet</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;name)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refresh()">refresh</a></span>()</code></th>
<td class="colLast">
<div class="block">Refresh this context.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.Context">
<!-- -->
</a>
<h3>Methods declared in class&nbsp;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#getCommandNames()">getCommandNames</a>, <a href="Context.html#getPluginManager()">getPluginManager</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.IContext">
<!-- -->
</a>
<h3>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#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#getPluginClassloader()">getPluginClassloader</a>, <a href="IContext.html#getProperties()">getProperties</a>, <a href="IContext.html#isCommandRecognised(java.lang.String)">isCommandRecognised</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.IDTFJContext">
<!-- -->
</a>
<h3>Methods declared in interface&nbsp;com.ibm.java.diagnostics.utils.<a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></h3>
<code><a href="IDTFJContext.html#getAddressSpace()">getAddressSpace</a>, <a href="IDTFJContext.html#getImage()">getImage</a>, <a href="IDTFJContext.html#getMajorVersion()">getMajorVersion</a>, <a href="IDTFJContext.html#getMinorVersion()">getMinorVersion</a>, <a href="IDTFJContext.html#getProcess()">getProcess</a>, <a href="IDTFJContext.html#getRuntime()">getRuntime</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.ibm.java.diagnostics.utils.plugins.PluginLoader">
<!-- -->
</a>
<h3>Methods declared in interface&nbsp;com.ibm.java.diagnostics.utils.plugins.<a href="plugins/PluginLoader.html" title="interface in com.ibm.java.diagnostics.utils.plugins">PluginLoader</a></h3>
<code><a href="plugins/PluginLoader.html#getPluginFailures()">getPluginFailures</a>, <a href="plugins/PluginLoader.html#getPlugins()">getPlugins</a>, <a href="plugins/PluginLoader.html#loadPlugins()">loadPlugins</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(int,int,com.ibm.dtfj.image.Image,com.ibm.dtfj.image.ImageAddressSpace,com.ibm.dtfj.image.ImageProcess,com.ibm.dtfj.java.JavaRuntime)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DTFJContext</h4>
<pre>public&nbsp;DTFJContext&#8203;(int&nbsp;major,
int&nbsp;minor,
<a href="../../../dtfj/image/Image.html" title="interface in com.ibm.dtfj.image">Image</a>&nbsp;image,
<a href="../../../dtfj/image/ImageAddressSpace.html" title="interface in com.ibm.dtfj.image">ImageAddressSpace</a>&nbsp;space,
<a href="../../../dtfj/image/ImageProcess.html" title="interface in com.ibm.dtfj.image">ImageProcess</a>&nbsp;proc,
<a href="../../../dtfj/java/JavaRuntime.html" title="interface in com.ibm.dtfj.java">JavaRuntime</a>&nbsp;rt)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="refresh()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refresh</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;refresh()</pre>
<div class="block">Refresh this context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IContext.html#refresh()">refresh</a></code>&nbsp;in interface&nbsp;<code><a href="IContext.html" title="interface in com.ibm.java.diagnostics.utils">IContext</a></code></dd>
</dl>
</li>
</ul>
<a id="hasPropertyBeenSet(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hasPropertyBeenSet</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasPropertyBeenSet&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;name)</pre>
<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IDTFJContext.html#hasPropertyBeenSet(java.lang.String)">hasPropertyBeenSet</a></code>&nbsp;in interface&nbsp;<code><a href="IDTFJContext.html" title="interface in com.ibm.java.diagnostics.utils">IDTFJContext</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - property name to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the property exists and Boolean.parseValue() returns true</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</body>
</html>