http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/debug/DebugModel.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/debug/DebugModel.html b/builds/2.3.24-pre01/_html/api/freemarker/debug/DebugModel.html new file mode 100644 index 0000000..f2bfc8f --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/debug/DebugModel.html @@ -0,0 +1,748 @@ +<!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_20) on Wed Sep 02 01:20:17 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DebugModel (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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="DebugModel (FreeMarker 2.3.24-pre01 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":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/DebugModel.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/DebuggerListener.html" title="interface in freemarker.debug"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/debug/EnvironmentSuspendedEvent.html" title="class in freemarker.debug"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/debug/DebugModel.html" target="_top">Frames</a></li> +<li><a href="DebugModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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 DebugModel" class="title">Interface DebugModel</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../freemarker/debug/DebuggedEnvironment.html" title="interface in freemarker.debug">DebuggedEnvironment</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DebugModel</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></pre> +<div class="block">Represents the debugger-side mirror of a TemplateModel object, a Template + object, or a Configuration object. The Environment objects are also represented + by instances of this model, although not directly but through a separate + subinterface <a href="../../freemarker/debug/DebuggedEnvironment.html" title="interface in freemarker.debug"><code>DebuggedEnvironment</code></a>. The interface is a union of + almost all of FreeMarker template models with identical method signatures. + For purposes of optimizing network traffic there are bulk retrieval methods + for sequences and hashes, as well as a <a href="../../freemarker/debug/DebugModel.html#getModelTypes--"><code>getModelTypes()</code></a> method that + returns a bit mask of various <tt>TYPE_xxx</tt> constants flagging which + template models are implemented by the mirrored object.</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_BOOLEAN">TYPE_BOOLEAN</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_COLLECTION">TYPE_COLLECTION</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_CONFIGURATION">TYPE_CONFIGURATION</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_DATE">TYPE_DATE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_ENVIRONMENT">TYPE_ENVIRONMENT</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_HASH">TYPE_HASH</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_HASH_EX">TYPE_HASH_EX</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_METHOD">TYPE_METHOD</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_METHOD_EX">TYPE_METHOD_EX</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_NUMBER">TYPE_NUMBER</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_SCALAR">TYPE_SCALAR</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_SEQUENCE">TYPE_SEQUENCE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_TEMPLATE">TYPE_TEMPLATE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#TYPE_TRANSFORM">TYPE_TRANSFORM</a></span></code> </td> +</tr> +</table> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#get-int-">get</a></span>(int index)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#get-int-int-">get</a></span>(int fromIndex, + int toIndex)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#get-java.lang.String:A-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] keys)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getAsBoolean--">getAsBoolean</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getAsDate--">getAsDate</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getAsNumber--">getAsNumber</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getAsString--">getAsString</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getCollection--">getCollection</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getDateType--">getDateType</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#getModelTypes--">getModelTypes</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#keys--">keys</a></span>()</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebugModel.html#size--">size</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="TYPE_SCALAR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_SCALAR</h4> +<pre>static final int TYPE_SCALAR</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_SCALAR">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_NUMBER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_NUMBER</h4> +<pre>static final int TYPE_NUMBER</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_NUMBER">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_DATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_DATE</h4> +<pre>static final int TYPE_DATE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_DATE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_BOOLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_BOOLEAN</h4> +<pre>static final int TYPE_BOOLEAN</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_BOOLEAN">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_SEQUENCE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_SEQUENCE</h4> +<pre>static final int TYPE_SEQUENCE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_SEQUENCE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_COLLECTION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_COLLECTION</h4> +<pre>static final int TYPE_COLLECTION</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_COLLECTION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_HASH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_HASH</h4> +<pre>static final int TYPE_HASH</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_HASH">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_HASH_EX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_HASH_EX</h4> +<pre>static final int TYPE_HASH_EX</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_HASH_EX">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_METHOD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_METHOD</h4> +<pre>static final int TYPE_METHOD</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_METHOD">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_METHOD_EX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_METHOD_EX</h4> +<pre>static final int TYPE_METHOD_EX</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_METHOD_EX">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_TRANSFORM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_TRANSFORM</h4> +<pre>static final int TYPE_TRANSFORM</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_TRANSFORM">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_ENVIRONMENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_ENVIRONMENT</h4> +<pre>static final int TYPE_ENVIRONMENT</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_ENVIRONMENT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_TEMPLATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_TEMPLATE</h4> +<pre>static final int TYPE_TEMPLATE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_TEMPLATE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_CONFIGURATION"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TYPE_CONFIGURATION</h4> +<pre>static final int TYPE_CONFIGURATION</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.DebugModel.TYPE_CONFIGURATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAsString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsString</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAsString() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getAsNumber--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsNumber</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> getAsNumber() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getAsBoolean--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsBoolean</h4> +<pre>boolean getAsBoolean() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getAsDate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsDate</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getAsDate() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getDateType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDateType</h4> +<pre>int getDateType() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="size--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>int size() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="get-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a> get(int index) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="get-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>[] get(int fromIndex, + int toIndex) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="get-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a> get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="get-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>[] get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] keys) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getCollection--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCollection</h4> +<pre><a href="../../freemarker/debug/DebugModel.html" title="interface in freemarker.debug">DebugModel</a>[] getCollection() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="keys--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] keys() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getModelTypes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getModelTypes</h4> +<pre>int getModelTypes() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></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/DebugModel.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/DebuggerListener.html" title="interface in freemarker.debug"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/debug/EnvironmentSuspendedEvent.html" title="class in freemarker.debug"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/debug/DebugModel.html" target="_top">Frames</a></li> +<li><a href="DebugModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggedEnvironment.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggedEnvironment.html b/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggedEnvironment.html new file mode 100644 index 0000000..1722ae1 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggedEnvironment.html @@ -0,0 +1,315 @@ +<!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_20) on Wed Sep 02 01:20:17 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DebuggedEnvironment (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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.24-pre01 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 Class</span></a></li> +<li><a href="../../freemarker/debug/Debugger.html" title="interface in freemarker.debug"><span class="typeNameLink">Next 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 Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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>, <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></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 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="../../fr eemarker/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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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 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--">siz e</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 resume() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></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><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>void stop() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></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><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getId</h4> +<pre>long getId() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Returns a unique identifier for this environment</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></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 Class</span></a></li> +<li><a href="../../freemarker/debug/Debugger.html" title="interface in freemarker.debug"><span class="typeNameLink">Next 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 Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/debug/Debugger.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/debug/Debugger.html b/builds/2.3.24-pre01/_html/api/freemarker/debug/Debugger.html new file mode 100644 index 0000000..217eec5 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/debug/Debugger.html @@ -0,0 +1,459 @@ +<!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_20) on Wed Sep 02 01:20:17 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Debugger (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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="Debugger (FreeMarker 2.3.24-pre01 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/Debugger.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/DebuggedEnvironment.html" title="interface in freemarker.debug"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/debug/DebuggerClient.html" title="class in freemarker.debug"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/debug/Debugger.html" target="_top">Frames</a></li> +<li><a href="Debugger.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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 Debugger" class="title">Interface Debugger</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Debugger</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></pre> +<div class="block">The main debugger interface. Allows management of breakpoints as well as + installation of listeners for debug events.</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#DEFAULT_PORT">DEFAULT_PORT</a></span></code> </td> +</tr> +</table> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#addBreakpoint-freemarker.debug.Breakpoint-">addBreakpoint</a></span>(<a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug">Breakpoint</a> breakpoint)</code> +<div class="block">Adds a breakpoint</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#addDebuggerListener-freemarker.debug.DebuggerListener-">addDebuggerListener</a></span>(<a href="../../freemarker/debug/DebuggerListener.html" title="interface in freemarker.debug">DebuggerListener</a> listener)</code> +<div class="block">Adds a listener for debugger events.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#getBreakpoints--">getBreakpoints</a></span>()</code> +<div class="block">Retrieves a list of all <a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug"><code>Breakpoint</code></a> objects.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#getBreakpoints-java.lang.String-">getBreakpoints</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName)</code> +<div class="block">Retrieves a list of all <a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug"><code>Breakpoint</code></a> objects for the specified + template.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#getSuspendedEnvironments--">getSuspendedEnvironments</a></span>()</code> +<div class="block">Retrieves a collection of all <a href="../../freemarker/debug/DebuggedEnvironment.html" title="interface in freemarker.debug"><code>DebuggedEnvironment</code></a> objects that + are currently suspended.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#removeBreakpoint-freemarker.debug.Breakpoint-">removeBreakpoint</a></span>(<a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug">Breakpoint</a> breakpoint)</code> +<div class="block">Removes a single breakpoint</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#removeBreakpoints--">removeBreakpoints</a></span>()</code> +<div class="block">Removes all breakpoints</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#removeBreakpoints-java.lang.String-">removeBreakpoints</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName)</code> +<div class="block">Removes all breakpoints for a specific template</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#removeDebuggerListener-java.lang.Object-">removeDebuggerListener</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> id)</code> +<div class="block">Removes a previously added debugger listener.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT_PORT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_PORT</h4> +<pre>static final int DEFAULT_PORT</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.debug.Debugger.DEFAULT_PORT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addBreakpoint-freemarker.debug.Breakpoint-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addBreakpoint</h4> +<pre>void addBreakpoint(<a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug">Breakpoint</a> breakpoint) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Adds a breakpoint</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>breakpoint</code> - the breakpoint to add</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="removeBreakpoint-freemarker.debug.Breakpoint-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeBreakpoint</h4> +<pre>void removeBreakpoint(<a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug">Breakpoint</a> breakpoint) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Removes a single breakpoint</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>breakpoint</code> - the breakpoint to remove</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="removeBreakpoints-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeBreakpoints</h4> +<pre>void removeBreakpoints(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Removes all breakpoints for a specific template</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="removeBreakpoints--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeBreakpoints</h4> +<pre>void removeBreakpoints() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Removes all breakpoints</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getBreakpoints--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBreakpoints</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> getBreakpoints() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Retrieves a list of all <a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug"><code>Breakpoint</code></a> objects.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getBreakpoints-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBreakpoints</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> getBreakpoints(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Retrieves a list of all <a href="../../freemarker/debug/Breakpoint.html" title="class in freemarker.debug"><code>Breakpoint</code></a> objects for the specified + template.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="getSuspendedEnvironments--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSuspendedEnvironments</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> getSuspendedEnvironments() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Retrieves a collection of all <a href="../../freemarker/debug/DebuggedEnvironment.html" title="interface in freemarker.debug"><code>DebuggedEnvironment</code></a> objects that + are currently suspended.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="addDebuggerListener-freemarker.debug.DebuggerListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDebuggerListener</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> addDebuggerListener(<a href="../../freemarker/debug/DebuggerListener.html" title="interface in freemarker.debug">DebuggerListener</a> listener) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Adds a listener for debugger events.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an identification token that should be passed to + <a href="../../freemarker/debug/Debugger.html#removeDebuggerListener-java.lang.Object-"><code>removeDebuggerListener(Object)</code></a> to remove this listener.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd> +</dl> +</li> +</ul> +<a name="removeDebuggerListener-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removeDebuggerListener</h4> +<pre>void removeDebuggerListener(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> id) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> +<div class="block">Removes a previously added debugger listener.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - the identification token for the listener that was returned + from a prior call to <a href="../../freemarker/debug/Debugger.html#addDebuggerListener-freemarker.debug.DebuggerListener-"><code>addDebuggerListener(DebuggerListener)</code></a>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></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/Debugger.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/DebuggedEnvironment.html" title="interface in freemarker.debug"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/debug/DebuggerClient.html" title="class in freemarker.debug"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/debug/Debugger.html" target="_top">Frames</a></li> +<li><a href="Debugger.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggerClient.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggerClient.html b/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggerClient.html new file mode 100644 index 0000000..2379e3b --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/debug/DebuggerClient.html @@ -0,0 +1,267 @@ +<!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_20) on Wed Sep 02 01:20:17 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DebuggerClient (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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="DebuggerClient (FreeMarker 2.3.24-pre01 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/DebuggerClient.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/Debugger.html" title="interface in freemarker.debug"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/debug/DebuggerListener.html" title="interface in freemarker.debug"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/debug/DebuggerClient.html" target="_top">Frames</a></li> +<li><a href="DebuggerClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Class DebuggerClient" class="title">Class DebuggerClient</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.debug.DebuggerClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DebuggerClient</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">A utility class that allows you to connect to the FreeMarker debugger service + running on a specific host and port.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="../../freemarker/debug/Debugger.html" title="interface in freemarker.debug">Debugger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/DebuggerClient.html#getDebugger-java.net.InetAddress-int-java.lang.String-">getDebugger</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> host, + int port, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> +<div class="block">Connects to the FreeMarker debugger service running on a specific host + and port.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</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="getDebugger-java.net.InetAddress-int-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDebugger</h4> +<pre>public static <a href="../../freemarker/debug/Debugger.html" title="interface in freemarker.debug">Debugger</a> getDebugger(<a href="http://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> host, + int port, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Connects to the FreeMarker debugger service running on a specific host + and port. The Java VM to which the connection is made must have defined + the system property <tt>freemarker.debug.password</tt> in order to enable + the debugger service. Additionally, the <tt>freemarker.debug.port</tt> + system property can be set to specify the port where the debugger service + is listening. When not specified, it defaults to + <a href="../../freemarker/debug/Debugger.html#DEFAULT_PORT"><code>Debugger.DEFAULT_PORT</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>host</code> - the host address of the machine where the debugger service is + running.</dd> +<dd><code>port</code> - the port of the debugger service</dd> +<dd><code>password</code> - the password required to connect to the debugger service</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Debugger a debugger object. null is returned in case incorrect + password was supplied.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an exception occurs.</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/DebuggerClient.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/Debugger.html" title="interface in freemarker.debug"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/debug/DebuggerListener.html" title="interface in freemarker.debug"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/debug/DebuggerClient.html" target="_top">Frames</a></li> +<li><a href="DebuggerClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
