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