PageRenderTime 137ms CodeModel.GetById 42ms app.highlight 71ms RepoModel.GetById 2ms app.codeStats 1ms

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