| <!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>Debugger (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="Debugger (FreeMarker 2.3.32 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>java.rmi.Remote</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Debugger</span> |
| extends java.rmi.Remote</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>java.lang.Object</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>java.util.List</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>java.util.List</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/debug/Debugger.html#getBreakpoints-java.lang.String-">getBreakpoints</a></span>(java.lang.String 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>java.util.Collection</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>(java.lang.String 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>(java.lang.Object 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 java.rmi.RemoteException</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>java.rmi.RemoteException</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 java.rmi.RemoteException</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>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeBreakpoints-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeBreakpoints</h4> |
| <pre>void removeBreakpoints(java.lang.String templateName) |
| throws java.rmi.RemoteException</pre> |
| <div class="block">Removes all breakpoints for a specific template</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeBreakpoints--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeBreakpoints</h4> |
| <pre>void removeBreakpoints() |
| throws java.rmi.RemoteException</pre> |
| <div class="block">Removes all breakpoints</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBreakpoints--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBreakpoints</h4> |
| <pre>java.util.List getBreakpoints() |
| throws java.rmi.RemoteException</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>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBreakpoints-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBreakpoints</h4> |
| <pre>java.util.List getBreakpoints(java.lang.String templateName) |
| throws java.rmi.RemoteException</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>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSuspendedEnvironments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuspendedEnvironments</h4> |
| <pre>java.util.Collection getSuspendedEnvironments() |
| throws java.rmi.RemoteException</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>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addDebuggerListener-freemarker.debug.DebuggerListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDebuggerListener</h4> |
| <pre>java.lang.Object addDebuggerListener(<a href="../../freemarker/debug/DebuggerListener.html" title="interface in freemarker.debug">DebuggerListener</a> listener) |
| throws java.rmi.RemoteException</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>java.rmi.RemoteException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeDebuggerListener-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeDebuggerListener</h4> |
| <pre>void removeDebuggerListener(java.lang.Object id) |
| throws java.rmi.RemoteException</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>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/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> |
