PageRenderTime 62ms CodeModel.GetById 23ms app.highlight 30ms RepoModel.GetById 2ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/bsh/BSHFormalComment.html

#
HTML | 746 lines | 655 code | 77 blank | 14 comment | 0 complexity | 18bea7ec20efbc101b691b8fd47ec858 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:13:49 GMT-08:00 2008 -->
  6<TITLE>
  7BSHFormalComment (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.bsh.BSHFormalComment class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BSHFormalComment.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/BshClassManager.Listener.html" title="interface in org.gjt.sp.jedit.bsh"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/BshIterator.html" title="interface in org.gjt.sp.jedit.bsh"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/bsh/BSHFormalComment.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="BSHFormalComment.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit.bsh</FONT>
 78<BR>
 79Class BSHFormalComment</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.bsh.BSHFormalComment</B>
 83</PRE>
 84<HR>
 85<DL>
 86<DT><PRE>public class <B>BSHFormalComment</B><DT>extends java.lang.Object</DL>
 87</PRE>
 88
 89<P>
 90<DL>
 91<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.gjt.sp.jedit.bsh.BSHFormalComment">Serialized Form</A></DL>
 92<HR>
 93
 94<P>
 95<!-- =========== FIELD SUMMARY =========== -->
 96
 97<A NAME="field_summary"><!-- --></A>
 98<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 99<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
100<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
101<B>Field Summary</B></FONT></TH>
102</TR>
103<TR BGCOLOR="white" CLASS="TableRowColor">
104<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
105<CODE>protected &nbsp;org.gjt.sp.jedit.bsh.Node[]</CODE></FONT></TD>
106<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#children">children</A></B></CODE>
107
108<BR>
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
110</TR>
111<TR BGCOLOR="white" CLASS="TableRowColor">
112<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
113<CODE>protected &nbsp;int</CODE></FONT></TD>
114<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#id">id</A></B></CODE>
115
116<BR>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>static&nbsp;org.gjt.sp.jedit.bsh.SimpleNode</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#JAVACODE">JAVACODE</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>protected &nbsp;org.gjt.sp.jedit.bsh.Node</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#parent">parent</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#text">text</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143</TABLE>
144&nbsp;
145<!-- ======== CONSTRUCTOR SUMMARY ======== -->
146
147<A NAME="constructor_summary"><!-- --></A>
148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
151<B>Constructor Summary</B></FONT></TH>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#BSHFormalComment(int)">BSHFormalComment</A></B>(int&nbsp;id)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159</TABLE>
160&nbsp;
161<!-- ========== METHOD SUMMARY =========== -->
162
163<A NAME="method_summary"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
167<B>Method Summary</B></FONT></TH>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#dump(java.lang.String)">dump</A></B>(java.lang.String&nbsp;prefix)</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#eval(org.gjt.sp.jedit.bsh.CallStack, org.gjt.sp.jedit.bsh.Interpreter)">eval</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/bsh/CallStack.html" title="class in org.gjt.sp.jedit.bsh">CallStack</A>&nbsp;callstack,
181     <A HREF="../../../../../org/gjt/sp/jedit/bsh/Interpreter.html" title="class in org.gjt.sp.jedit.bsh">Interpreter</A>&nbsp;interpreter)</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is the general signature for evaluation of a node.</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>&nbsp;org.gjt.sp.jedit.bsh.SimpleNode</CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#getChild(int)">getChild</A></B>(int&nbsp;i)</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>&nbsp;int</CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#getLineNumber()">getLineNumber</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the line number of the starting token</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#getSourceFile()">getSourceFile</A></B>()</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the source file (or more generally source) of
209                the text from which this node was parsed.</TD>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
214<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#getText()">getText</A></B>()</CODE>
215
216<BR>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the text of the tokens comprising this node.</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>&nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtAddChild(org.gjt.sp.jedit.bsh.Node, int)">jjtAddChild</A></B>(org.gjt.sp.jedit.bsh.Node&nbsp;n,
223            int&nbsp;i)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method tells the node to add its argument to the node's
227        list of children.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtClose()">jjtClose</A></B>()</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called after all the child nodes have been
236        added.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;org.gjt.sp.jedit.bsh.Node</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtGetChild(int)">jjtGetChild</A></B>(int&nbsp;i)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a child node.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;int</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtGetNumChildren()">jjtGetNumChildren</A></B>()</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the number of children the node has.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;org.gjt.sp.jedit.bsh.Node</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtGetParent()">jjtGetParent</A></B>()</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtOpen()">jjtOpen</A></B>()</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called after the node has been made the current
269        node.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;void</CODE></FONT></TD>
274<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#jjtSetParent(org.gjt.sp.jedit.bsh.Node)">jjtSetParent</A></B>(org.gjt.sp.jedit.bsh.Node&nbsp;n)</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This pair of methods are used to inform the node of its
278        parent.</TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282<CODE>&nbsp;void</CODE></FONT></TD>
283<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#prune()">prune</A></B>()</CODE>
284
285<BR>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Detach this node from its parent.</TD>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
290<CODE>&nbsp;void</CODE></FONT></TD>
291<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#setSourceFile(java.lang.String)">setSourceFile</A></B>(java.lang.String&nbsp;sourceFile)</CODE>
292
293<BR>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the source file (or more generally source) of
295                the text from which this node was parsed.</TD>
296</TR>
297<TR BGCOLOR="white" CLASS="TableRowColor">
298<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
300<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#toString()">toString</A></B>()</CODE>
301
302<BR>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
308<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/BSHFormalComment.html#toString(java.lang.String)">toString</A></B>(java.lang.String&nbsp;prefix)</CODE>
309
310<BR>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
312</TR>
313</TABLE>
314&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
317<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
321</TR>
322</TABLE>
323&nbsp;
324<P>
325
326<!-- ============ FIELD DETAIL =========== -->
327
328<A NAME="field_detail"><!-- --></A>
329<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
330<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
331<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
332<B>Field Detail</B></FONT></TH>
333</TR>
334</TABLE>
335
336<A NAME="text"><!-- --></A><H3>
337text</H3>
338<PRE>
339public java.lang.String <B>text</B></PRE>
340<DL>
341<DL>
342</DL>
343</DL>
344<HR>
345
346<A NAME="JAVACODE"><!-- --></A><H3>
347JAVACODE</H3>
348<PRE>
349public static org.gjt.sp.jedit.bsh.SimpleNode <B>JAVACODE</B></PRE>
350<DL>
351<DL>
352</DL>
353</DL>
354<HR>
355
356<A NAME="parent"><!-- --></A><H3>
357parent</H3>
358<PRE>
359protected org.gjt.sp.jedit.bsh.Node <B>parent</B></PRE>
360<DL>
361<DL>
362</DL>
363</DL>
364<HR>
365
366<A NAME="children"><!-- --></A><H3>
367children</H3>
368<PRE>
369protected org.gjt.sp.jedit.bsh.Node[] <B>children</B></PRE>
370<DL>
371<DL>
372</DL>
373</DL>
374<HR>
375
376<A NAME="id"><!-- --></A><H3>
377id</H3>
378<PRE>
379protected int <B>id</B></PRE>
380<DL>
381<DL>
382</DL>
383</DL>
384
385<!-- ========= CONSTRUCTOR DETAIL ======== -->
386
387<A NAME="constructor_detail"><!-- --></A>
388<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
389<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
390<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
391<B>Constructor Detail</B></FONT></TH>
392</TR>
393</TABLE>
394
395<A NAME="BSHFormalComment(int)"><!-- --></A><H3>
396BSHFormalComment</H3>
397<PRE>
398public <B>BSHFormalComment</B>(int&nbsp;id)</PRE>
399<DL>
400</DL>
401
402<!-- ============ METHOD DETAIL ========== -->
403
404<A NAME="method_detail"><!-- --></A>
405<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
406<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
407<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
408<B>Method Detail</B></FONT></TH>
409</TR>
410</TABLE>
411
412<A NAME="jjtOpen()"><!-- --></A><H3>
413jjtOpen</H3>
414<PRE>
415public void <B>jjtOpen</B>()</PRE>
416<DL>
417<DD>This method is called after the node has been made the current
418        node.  It indicates that child nodes can now be added to it.
419<P>
420<DD><DL>
421</DL>
422</DD>
423<DD><DL>
424</DL>
425</DD>
426</DL>
427<HR>
428
429<A NAME="jjtClose()"><!-- --></A><H3>
430jjtClose</H3>
431<PRE>
432public void <B>jjtClose</B>()</PRE>
433<DL>
434<DD>This method is called after all the child nodes have been
435        added.
436<P>
437<DD><DL>
438</DL>
439</DD>
440<DD><DL>
441</DL>
442</DD>
443</DL>
444<HR>
445
446<A NAME="jjtSetParent(org.gjt.sp.jedit.bsh.Node)"><!-- --></A><H3>
447jjtSetParent</H3>
448<PRE>
449public void <B>jjtSetParent</B>(org.gjt.sp.jedit.bsh.Node&nbsp;n)</PRE>
450<DL>
451<DD>This pair of methods are used to inform the node of its
452        parent.
453<P>
454<DD><DL>
455</DL>
456</DD>
457<DD><DL>
458</DL>
459</DD>
460</DL>
461<HR>
462
463<A NAME="jjtGetParent()"><!-- --></A><H3>
464jjtGetParent</H3>
465<PRE>
466public org.gjt.sp.jedit.bsh.Node <B>jjtGetParent</B>()</PRE>
467<DL>
468<DD><DL>
469</DL>
470</DD>
471<DD><DL>
472</DL>
473</DD>
474</DL>
475<HR>
476
477<A NAME="jjtAddChild(org.gjt.sp.jedit.bsh.Node, int)"><!-- --></A><H3>
478jjtAddChild</H3>
479<PRE>
480public void <B>jjtAddChild</B>(org.gjt.sp.jedit.bsh.Node&nbsp;n,
481                        int&nbsp;i)</PRE>
482<DL>
483<DD>This method tells the node to add its argument to the node's
484        list of children.
485<P>
486<DD><DL>
487</DL>
488</DD>
489<DD><DL>
490</DL>
491</DD>
492</DL>
493<HR>
494
495<A NAME="jjtGetChild(int)"><!-- --></A><H3>
496jjtGetChild</H3>
497<PRE>
498public org.gjt.sp.jedit.bsh.Node <B>jjtGetChild</B>(int&nbsp;i)</PRE>
499<DL>
500<DD>This method returns a child node.  The children are numbered
501        from zero, left to right.
502<P>
503<DD><DL>
504</DL>
505</DD>
506<DD><DL>
507</DL>
508</DD>
509</DL>
510<HR>
511
512<A NAME="getChild(int)"><!-- --></A><H3>
513getChild</H3>
514<PRE>
515public org.gjt.sp.jedit.bsh.SimpleNode <B>getChild</B>(int&nbsp;i)</PRE>
516<DL>
517<DD><DL>
518</DL>
519</DD>
520<DD><DL>
521</DL>
522</DD>
523</DL>
524<HR>
525
526<A NAME="jjtGetNumChildren()"><!-- --></A><H3>
527jjtGetNumChildren</H3>
528<PRE>
529public int <B>jjtGetNumChildren</B>()</PRE>
530<DL>
531<DD>Return the number of children the node has.
532<P>
533<DD><DL>
534</DL>
535</DD>
536<DD><DL>
537</DL>
538</DD>
539</DL>
540<HR>
541
542<A NAME="toString()"><!-- --></A><H3>
543toString</H3>
544<PRE>
545public java.lang.String <B>toString</B>()</PRE>
546<DL>
547<DD><DL>
548<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
549</DD>
550<DD><DL>
551</DL>
552</DD>
553</DL>
554<HR>
555
556<A NAME="toString(java.lang.String)"><!-- --></A><H3>
557toString</H3>
558<PRE>
559public java.lang.String <B>toString</B>(java.lang.String&nbsp;prefix)</PRE>
560<DL>
561<DD><DL>
562</DL>
563</DD>
564<DD><DL>
565</DL>
566</DD>
567</DL>
568<HR>
569
570<A NAME="dump(java.lang.String)"><!-- --></A><H3>
571dump</H3>
572<PRE>
573public void <B>dump</B>(java.lang.String&nbsp;prefix)</PRE>
574<DL>
575<DD><DL>
576</DL>
577</DD>
578<DD><DL>
579</DL>
580</DD>
581</DL>
582<HR>
583
584<A NAME="prune()"><!-- --></A><H3>
585prune</H3>
586<PRE>
587public void <B>prune</B>()</PRE>
588<DL>
589<DD>Detach this node from its parent.
590                This is primarily useful in node serialization.
591                (see BSHMethodDeclaration)
592<P>
593<DD><DL>
594</DL>
595</DD>
596<DD><DL>
597</DL>
598</DD>
599</DL>
600<HR>
601
602<A NAME="eval(org.gjt.sp.jedit.bsh.CallStack, org.gjt.sp.jedit.bsh.Interpreter)"><!-- --></A><H3>
603eval</H3>
604<PRE>
605public java.lang.Object <B>eval</B>(<A HREF="../../../../../org/gjt/sp/jedit/bsh/CallStack.html" title="class in org.gjt.sp.jedit.bsh">CallStack</A>&nbsp;callstack,
606                             <A HREF="../../../../../org/gjt/sp/jedit/bsh/Interpreter.html" title="class in org.gjt.sp.jedit.bsh">Interpreter</A>&nbsp;interpreter)
607                      throws <A HREF="../../../../../org/gjt/sp/jedit/bsh/EvalError.html" title="class in org.gjt.sp.jedit.bsh">EvalError</A></PRE>
608<DL>
609<DD>This is the general signature for evaluation of a node.
610<P>
611<DD><DL>
612</DL>
613</DD>
614<DD><DL>
615
616<DT><B>Throws:</B>
617<DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/bsh/EvalError.html" title="class in org.gjt.sp.jedit.bsh">EvalError</A></CODE></DL>
618</DD>
619</DL>
620<HR>
621
622<A NAME="setSourceFile(java.lang.String)"><!-- --></A><H3>
623setSourceFile</H3>
624<PRE>
625public void <B>setSourceFile</B>(java.lang.String&nbsp;sourceFile)</PRE>
626<DL>
627<DD>Set the name of the source file (or more generally source) of
628                the text from which this node was parsed.
629<P>
630<DD><DL>
631</DL>
632</DD>
633<DD><DL>
634</DL>
635</DD>
636</DL>
637<HR>
638
639<A NAME="getSourceFile()"><!-- --></A><H3>
640getSourceFile</H3>
641<PRE>
642public java.lang.String <B>getSourceFile</B>()</PRE>
643<DL>
644<DD>Get the name of the source file (or more generally source) of
645                the text from which this node was parsed.
646                This will recursively search up the chain of parent nodes until
647                a source is found or return a string indicating that the source
648                is unknown.
649<P>
650<DD><DL>
651</DL>
652</DD>
653<DD><DL>
654</DL>
655</DD>
656</DL>
657<HR>
658
659<A NAME="getLineNumber()"><!-- --></A><H3>
660getLineNumber</H3>
661<PRE>
662public int <B>getLineNumber</B>()</PRE>
663<DL>
664<DD>Get the line number of the starting token
665<P>
666<DD><DL>
667</DL>
668</DD>
669<DD><DL>
670</DL>
671</DD>
672</DL>
673<HR>
674
675<A NAME="getText()"><!-- --></A><H3>
676getText</H3>
677<PRE>
678public java.lang.String <B>getText</B>()</PRE>
679<DL>
680<DD>Get the text of the tokens comprising this node.
681<P>
682<DD><DL>
683</DL>
684</DD>
685<DD><DL>
686</DL>
687</DD>
688</DL>
689<!-- ========= END OF CLASS DATA ========= -->
690<HR>
691
692
693<!-- ======= START OF BOTTOM NAVBAR ====== -->
694<A NAME="navbar_bottom"><!-- --></A>
695<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
696<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
697<TR>
698<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
699<A NAME="navbar_bottom_firstrow"><!-- --></A>
700<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
701  <TR ALIGN="center" VALIGN="top">
702  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
703  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
704  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
705  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BSHFormalComment.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
706  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
707  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
708  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
709  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
710  </TR>
711</TABLE>
712</TD>
713<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
714</EM>
715</TD>
716</TR>
717
718<TR>
719<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
720&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/BshClassManager.Listener.html" title="interface in org.gjt.sp.jedit.bsh"><B>PREV CLASS</B></A>&nbsp;
721&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/BshIterator.html" title="interface in org.gjt.sp.jedit.bsh"><B>NEXT CLASS</B></A></FONT></TD>
722<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
723  <A HREF="../../../../../index.html?org/gjt/sp/jedit/bsh/BSHFormalComment.html" target="_top"><B>FRAMES</B></A>  &nbsp;
724&nbsp;<A HREF="BSHFormalComment.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
725&nbsp;
726<NOSCRIPT>
727  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
728</NOSCRIPT>
729
730
731</FONT></TD>
732</TR>
733<TR>
734<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
735  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
736<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
737DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
738</TR>
739</TABLE>
740<A NAME="skip-navbar_bottom"></A>
741<!-- ======== END OF BOTTOM NAVBAR ======= -->
742
743<HR>
744
745</BODY>
746</HTML>