PageRenderTime 48ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 365 lines | 311 code | 42 blank | 12 comment | 0 complexity | a4154d34c5e1887d1e02e5cdbc29ebd7 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:50 GMT-08:00 2008 -->
  6. <TITLE>
  7. TokenMgrError (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.bsh.TokenMgrError 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/TokenMgrError.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/Token.html" title="class in org.gjt.sp.jedit.bsh"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/UtilEvalError.html" title="class 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/TokenMgrError.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="TokenMgrError.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;FIELD&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;FIELD&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 TokenMgrError</H2>
  68. <PRE>
  69. java.lang.Object
  70. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
  71. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Error
  72. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.bsh.TokenMgrError</B>
  73. </PRE>
  74. <DL>
  75. <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
  76. </DL>
  77. <HR>
  78. <DL>
  79. <DT><PRE>public class <B>TokenMgrError</B><DT>extends java.lang.Error</DL>
  80. </PRE>
  81. <P>
  82. <DL>
  83. <DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.gjt.sp.jedit.bsh.TokenMgrError">Serialized Form</A></DL>
  84. <HR>
  85. <P>
  86. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  87. <A NAME="constructor_summary"><!-- --></A>
  88. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  89. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  90. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  91. <B>Constructor Summary</B></FONT></TH>
  92. </TR>
  93. <TR BGCOLOR="white" CLASS="TableRowColor">
  94. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/TokenMgrError.html#TokenMgrError()">TokenMgrError</A></B>()</CODE>
  95. <BR>
  96. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  97. </TR>
  98. <TR BGCOLOR="white" CLASS="TableRowColor">
  99. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/TokenMgrError.html#TokenMgrError(boolean, int, int, int, java.lang.String, char, int)">TokenMgrError</A></B>(boolean&nbsp;EOFSeen,
  100. int&nbsp;lexState,
  101. int&nbsp;errorLine,
  102. int&nbsp;errorColumn,
  103. java.lang.String&nbsp;errorAfter,
  104. char&nbsp;curChar,
  105. int&nbsp;reason)</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><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/TokenMgrError.html#TokenMgrError(java.lang.String, int)">TokenMgrError</A></B>(java.lang.String&nbsp;message,
  111. int&nbsp;reason)</CODE>
  112. <BR>
  113. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  114. </TR>
  115. </TABLE>
  116. &nbsp;
  117. <!-- ========== METHOD SUMMARY =========== -->
  118. <A NAME="method_summary"><!-- --></A>
  119. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  120. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  121. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  122. <B>Method Summary</B></FONT></TH>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  126. <CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
  127. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/TokenMgrError.html#addEscapes(java.lang.String)">addEscapes</A></B>(java.lang.String&nbsp;str)</CODE>
  128. <BR>
  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces unprintable characters by their espaced (or unicode escaped)
  130. equivalents in the given string</TD>
  131. </TR>
  132. <TR BGCOLOR="white" CLASS="TableRowColor">
  133. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  134. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  135. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/TokenMgrError.html#getMessage()">getMessage</A></B>()</CODE>
  136. <BR>
  137. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;You can also modify the body of this method to customize your error messages.</TD>
  138. </TR>
  139. <TR BGCOLOR="white" CLASS="TableRowColor">
  140. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  141. <CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
  142. <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/bsh/TokenMgrError.html#LexicalError(boolean, int, int, int, java.lang.String, char)">LexicalError</A></B>(boolean&nbsp;EOFSeen,
  143. int&nbsp;lexState,
  144. int&nbsp;errorLine,
  145. int&nbsp;errorColumn,
  146. java.lang.String&nbsp;errorAfter,
  147. char&nbsp;curChar)</CODE>
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a detailed message for the Error when it is thrown by the
  150. token manager to indicate a lexical error.</TD>
  151. </TR>
  152. </TABLE>
  153. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
  154. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  155. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  156. <TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
  157. </TR>
  158. <TR BGCOLOR="white" CLASS="TableRowColor">
  159. <TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
  160. </TR>
  161. </TABLE>
  162. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  163. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  164. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  165. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  166. </TR>
  167. <TR BGCOLOR="white" CLASS="TableRowColor">
  168. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
  169. </TR>
  170. </TABLE>
  171. &nbsp;
  172. <P>
  173. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  174. <A NAME="constructor_detail"><!-- --></A>
  175. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  176. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  177. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  178. <B>Constructor Detail</B></FONT></TH>
  179. </TR>
  180. </TABLE>
  181. <A NAME="TokenMgrError()"><!-- --></A><H3>
  182. TokenMgrError</H3>
  183. <PRE>
  184. public <B>TokenMgrError</B>()</PRE>
  185. <DL>
  186. </DL>
  187. <HR>
  188. <A NAME="TokenMgrError(java.lang.String, int)"><!-- --></A><H3>
  189. TokenMgrError</H3>
  190. <PRE>
  191. public <B>TokenMgrError</B>(java.lang.String&nbsp;message,
  192. int&nbsp;reason)</PRE>
  193. <DL>
  194. </DL>
  195. <HR>
  196. <A NAME="TokenMgrError(boolean, int, int, int, java.lang.String, char, int)"><!-- --></A><H3>
  197. TokenMgrError</H3>
  198. <PRE>
  199. public <B>TokenMgrError</B>(boolean&nbsp;EOFSeen,
  200. int&nbsp;lexState,
  201. int&nbsp;errorLine,
  202. int&nbsp;errorColumn,
  203. java.lang.String&nbsp;errorAfter,
  204. char&nbsp;curChar,
  205. int&nbsp;reason)</PRE>
  206. <DL>
  207. </DL>
  208. <!-- ============ METHOD DETAIL ========== -->
  209. <A NAME="method_detail"><!-- --></A>
  210. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  211. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  212. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  213. <B>Method Detail</B></FONT></TH>
  214. </TR>
  215. </TABLE>
  216. <A NAME="addEscapes(java.lang.String)"><!-- --></A><H3>
  217. addEscapes</H3>
  218. <PRE>
  219. protected static final java.lang.String <B>addEscapes</B>(java.lang.String&nbsp;str)</PRE>
  220. <DL>
  221. <DD>Replaces unprintable characters by their espaced (or unicode escaped)
  222. equivalents in the given string
  223. <P>
  224. <DD><DL>
  225. </DL>
  226. </DD>
  227. </DL>
  228. <HR>
  229. <A NAME="LexicalError(boolean, int, int, int, java.lang.String, char)"><!-- --></A><H3>
  230. LexicalError</H3>
  231. <PRE>
  232. protected static java.lang.String <B>LexicalError</B>(boolean&nbsp;EOFSeen,
  233. int&nbsp;lexState,
  234. int&nbsp;errorLine,
  235. int&nbsp;errorColumn,
  236. java.lang.String&nbsp;errorAfter,
  237. char&nbsp;curChar)</PRE>
  238. <DL>
  239. <DD>Returns a detailed message for the Error when it is thrown by the
  240. token manager to indicate a lexical error.
  241. Parameters :
  242. EOFSeen : indicates if EOF caused the lexicl error
  243. curLexState : lexical state in which this error occured
  244. errorLine : line number when the error occured
  245. errorColumn : column number when the error occured
  246. errorAfter : prefix that was seen before this error occured
  247. curchar : the offending character
  248. Note: You can customize the lexical error message by modifying this method.
  249. <P>
  250. <DD><DL>
  251. </DL>
  252. </DD>
  253. </DL>
  254. <HR>
  255. <A NAME="getMessage()"><!-- --></A><H3>
  256. getMessage</H3>
  257. <PRE>
  258. public java.lang.String <B>getMessage</B>()</PRE>
  259. <DL>
  260. <DD>You can also modify the body of this method to customize your error messages.
  261. For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
  262. of end-users concern, so you can return something like :
  263. "Internal Error : Please file a bug report .... "
  264. from this method for such cases in the release version of your parser.
  265. <P>
  266. <DD><DL>
  267. <DT><B>Overrides:</B><DD><CODE>getMessage</CODE> in class <CODE>java.lang.Throwable</CODE></DL>
  268. </DD>
  269. <DD><DL>
  270. </DL>
  271. </DD>
  272. </DL>
  273. <!-- ========= END OF CLASS DATA ========= -->
  274. <HR>
  275. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  276. <A NAME="navbar_bottom"><!-- --></A>
  277. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  278. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  279. <TR>
  280. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  281. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  282. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  283. <TR ALIGN="center" VALIGN="top">
  284. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  285. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  286. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  287. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TokenMgrError.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  288. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  289. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  290. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  291. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  292. </TR>
  293. </TABLE>
  294. </TD>
  295. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  296. </EM>
  297. </TD>
  298. </TR>
  299. <TR>
  300. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  301. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/Token.html" title="class in org.gjt.sp.jedit.bsh"><B>PREV CLASS</B></A>&nbsp;
  302. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/bsh/UtilEvalError.html" title="class in org.gjt.sp.jedit.bsh"><B>NEXT CLASS</B></A></FONT></TD>
  303. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  304. <A HREF="../../../../../index.html?org/gjt/sp/jedit/bsh/TokenMgrError.html" target="_top"><B>FRAMES</B></A> &nbsp;
  305. &nbsp;<A HREF="TokenMgrError.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  306. &nbsp;
  307. <NOSCRIPT>
  308. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  309. </NOSCRIPT>
  310. </FONT></TD>
  311. </TR>
  312. <TR>
  313. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  314. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  315. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  316. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  317. </TR>
  318. </TABLE>
  319. <A NAME="skip-navbar_bottom"></A>
  320. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  321. <HR>
  322. </BODY>
  323. </HTML>