blob: 75a0215f7f46a5ad72527040fd500f662ba76235 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_281) on Sun Jan 15 15:58:34 CET 2023 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DebuggedEnvironment (FreeMarker 2.3.32 API)</title>
<meta name="date" content="2023-01-15">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DebuggedEnvironment (FreeMarker 2.3.32 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DebuggedEnvironment.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-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../freemarker/debug/Debugger.html" title="interface in freemarker.debug"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?freemarker/debug/DebuggedEnvironment.html" target="_top">Frames</a></li>
<li><a href="DebuggedEnvironment.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">freemarker.debug</div>
<h2 title="Interface DebuggedEnvironment" class="title">Interface DebuggedEnvironment</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>, java.rmi.Remote</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DebuggedEnvironment</span>
extends <a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a></pre>
<div class="block">Represents the debugger-side mirror of a debugged
<a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> object in the remote VM. This interface
extends <a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug"><code>DebugModel</code></a>, and the properties of the Environment are exposed
as hash keys on it. Specifically, the following keys are supported:
"currentNamespace", "dataModel", "globalNamespace", "knownVariables",
"mainNamespace", and "template".
<p>The debug model for the template supports keys "configuration" and "name".
<p>The debug model for the configuration supports key "sharedVariables".
<p>Additionally, all of the debug models for environment, template, and
configuration also support all the setting keys of
<a href="../../freemarker/core/Configurable.html" title="class in freemarker.core"><code>Configurable</code></a> objects.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.freemarker.debug.DebugModel">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;freemarker.debug.<a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a></h3>
<code><a href="../../freemarker/debug/DebugModel.html#TYPE_BOOLEAN">TYPE_BOOLEAN</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_COLLECTION">TYPE_COLLECTION</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_CONFIGURATION">TYPE_CONFIGURATION</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_DATE">TYPE_DATE</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_ENVIRONMENT">TYPE_ENVIRONMENT</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_HASH">TYPE_HASH</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_HASH_EX">TYPE_HASH_EX</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_METHOD">TYPE_METHOD</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_METHOD_EX">TYPE_METHOD_EX</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_NUMBER">TYPE_NUMBER</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_SCALAR">TYPE_SCALAR</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_SEQUENCE">TYPE_SEQUENCE</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_TEMPLATE">TYPE_TEMPLATE</a>, <a href="../../freemarker/debug/DebugModel.html#TYPE_TRANSFORM">TYPE_TRANSFORM</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebuggedEnvironment.html#getId--">getId</a></span>()</code>
<div class="block">Returns a unique identifier for this environment</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebuggedEnvironment.html#resume--">resume</a></span>()</code>
<div class="block">Resumes the processing of the environment in the remote VM after it was
stopped on a breakpoint.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebuggedEnvironment.html#stop--">stop</a></span>()</code>
<div class="block">Stops the processing of the environment after it was stopped on
a breakpoint.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.freemarker.debug.DebugModel">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;freemarker.debug.<a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a></h3>
<code><a href="../../freemarker/debug/DebugModel.html#get-int-">get</a>, <a href="../../freemarker/debug/DebugModel.html#get-int-int-">get</a>, <a href="../../freemarker/debug/DebugModel.html#get-java.lang.String-">get</a>, <a href="../../freemarker/debug/DebugModel.html#get-java.lang.String:A-">get</a>, <a href="../../freemarker/debug/DebugModel.html#getAsBoolean--">getAsBoolean</a>, <a href="../../freemarker/debug/DebugModel.html#getAsDate--">getAsDate</a>, <a href="../../freemarker/debug/DebugModel.html#getAsNumber--">getAsNumber</a>, <a href="../../freemarker/debug/DebugModel.html#getAsString--">getAsString</a>, <a href="../../freemarker/debug/DebugModel.html#getCollection--">getCollection</a>, <a href="../../freemarker/debug/DebugModel.html#getDateType--">getDateType</a>, <a href="../../freemarker/debug/DebugModel.html#getModelTypes--">getModelTypes</a>, <a href="../../freemarker/debug/DebugModel.html#keys--">keys</a>, <a href="../../freemarker/debug/DebugModel.html#size--">size</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="resume--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resume</h4>
<pre>void&nbsp;resume()
throws java.rmi.RemoteException</pre>
<div class="block">Resumes the processing of the environment in the remote VM after it was
stopped on a breakpoint.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.rmi.RemoteException</code></dd>
</dl>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop()
throws java.rmi.RemoteException</pre>
<div class="block">Stops the processing of the environment after it was stopped on
a breakpoint. Causes a <a href="../../freemarker/core/StopException.html" title="class in freemarker.core"><code>StopException</code></a> to be
thrown in the processing thread in the remote VM.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.rmi.RemoteException</code></dd>
</dl>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getId</h4>
<pre>long&nbsp;getId()
throws java.rmi.RemoteException</pre>
<div class="block">Returns a unique identifier for this environment</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.rmi.RemoteException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DebuggedEnvironment.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-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../freemarker/debug/Debugger.html" title="interface in freemarker.debug"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?freemarker/debug/DebuggedEnvironment.html" target="_top">Frames</a></li>
<li><a href="DebuggedEnvironment.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>