| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Demo.Html.ParseException Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_demo.html">Demo</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_demo_1_1_html.html">Html</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html">ParseException</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Demo.Html.ParseException Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>This exception is thrown when parse errors are encountered. You can explicitly create objects of this exception type by calling the method generateParseException in the generated parser. |
| <a href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#details">More...</a></p> |
| |
| <p>Inherits Exception.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1c575218e0c5028ed508f52791de34e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#a1c575218e0c5028ed508f52791de34e1">ParseException</a> (<a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> currentTokenVal, int[][] expectedTokenSequencesVal, System.String[] tokenImageVal)</td></tr> |
| <tr class="memdesc:a1c575218e0c5028ed508f52791de34e1"><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used by the method "generateParseException" in the generated parser. Calling this constructor generates a new object of this type with the fields "currentToken", "expectedTokenSequences", and "tokenImage" set. The boolean flag "specialConstructor" is also set to true to indicate that this constructor was used to create this object. This constructor calls its super class with the empty string to force the "toString" method of parent class "Throwable" to print the error message in the form: <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html" title="This exception is thrown when parse errors are encountered. You can explicitly create objects of this...">ParseException</a>: <result of getMessage> <a href="#a1c575218e0c5028ed508f52791de34e1"></a><br/></td></tr> |
| <tr class="separator:a1c575218e0c5028ed508f52791de34e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1bbbaeb9d8eccf486b8d119c4c8db10f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#a1bbbaeb9d8eccf486b8d119c4c8db10f">ParseException</a> ()</td></tr> |
| <tr class="memdesc:a1bbbaeb9d8eccf486b8d119c4c8db10f"><td class="mdescLeft"> </td><td class="mdescRight">The following constructors are for use by you for whatever purpose you can think of. Constructing the exception in this manner makes the exception behave in the normal way - i.e., as documented in the class "Throwable". The fields "errorToken", "expectedTokenSequences", and "tokenImage" do not contain relevant information. The JavaCC generated code does not use these constructors. <a href="#a1bbbaeb9d8eccf486b8d119c4c8db10f"></a><br/></td></tr> |
| <tr class="separator:a1bbbaeb9d8eccf486b8d119c4c8db10f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a18c74767ab80e1fa0025ac31890c93c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#a18c74767ab80e1fa0025ac31890c93c8">ParseException</a> (System.String message)</td></tr> |
| <tr class="separator:a18c74767ab80e1fa0025ac31890c93c8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:af301974df410cea8546231388f7ed545"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#af301974df410cea8546231388f7ed545">currentToken</a></td></tr> |
| <tr class="memdesc:af301974df410cea8546231388f7ed545"><td class="mdescLeft"> </td><td class="mdescRight">This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token. <a href="#af301974df410cea8546231388f7ed545"></a><br/></td></tr> |
| <tr class="separator:af301974df410cea8546231388f7ed545"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0d7257f924881ddde3bbc94bc25467fc"><td class="memItemLeft" align="right" valign="top">int[][] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#a0d7257f924881ddde3bbc94bc25467fc">expectedTokenSequences</a></td></tr> |
| <tr class="memdesc:a0d7257f924881ddde3bbc94bc25467fc"><td class="mdescLeft"> </td><td class="mdescRight">Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse. <a href="#a0d7257f924881ddde3bbc94bc25467fc"></a><br/></td></tr> |
| <tr class="separator:a0d7257f924881ddde3bbc94bc25467fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a72574dc44f52c08af7a651552aafaad3"><td class="memItemLeft" align="right" valign="top">System.String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#a72574dc44f52c08af7a651552aafaad3">tokenImage</a></td></tr> |
| <tr class="memdesc:a72574dc44f52c08af7a651552aafaad3"><td class="mdescLeft"> </td><td class="mdescRight">This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface. <a href="#a72574dc44f52c08af7a651552aafaad3"></a><br/></td></tr> |
| <tr class="separator:a72574dc44f52c08af7a651552aafaad3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:ab5dcfc0a737bd3243ac31f591ddde4fc"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html#ab5dcfc0a737bd3243ac31f591ddde4fc">Message</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab5dcfc0a737bd3243ac31f591ddde4fc"><td class="mdescLeft"> </td><td class="mdescRight">This method has the standard behavior when this object has been created using the standard constructors. Otherwise, it uses "currentToken" and "expectedTokenSequences" to generate a parse error message and returns it. If this object has been created due to a parse error, and you do not catch it (it gets thrown from the parser), then this method is called during the printing of the final stack trace, and hence the correct error message gets displayed. <a href="#ab5dcfc0a737bd3243ac31f591ddde4fc"></a><br/></td></tr> |
| <tr class="separator:ab5dcfc0a737bd3243ac31f591ddde4fc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>This exception is thrown when parse errors are encountered. You can explicitly create objects of this exception type by calling the method generateParseException in the generated parser. </p> |
| <p>You can modify this class to customize your error reporting mechanisms so long as you retain the public fields. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00035">35</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a1c575218e0c5028ed508f52791de34e1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Demo.Html.ParseException.ParseException </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> </td> |
| <td class="paramname"><em>currentTokenVal</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>expectedTokenSequencesVal</em>[][], </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String[] </td> |
| <td class="paramname"><em>tokenImageVal</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This constructor is used by the method "generateParseException" in the generated parser. Calling this constructor generates a new object of this type with the fields "currentToken", "expectedTokenSequences", and "tokenImage" set. The boolean flag "specialConstructor" is also set to true to indicate that this constructor was used to create this object. This constructor calls its super class with the empty string to force the "toString" method of parent class "Throwable" to print the error message in the form: <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_parse_exception.html" title="This exception is thrown when parse errors are encountered. You can explicitly create objects of this...">ParseException</a>: <result of getMessage> </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00113">113</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1bbbaeb9d8eccf486b8d119c4c8db10f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Demo.Html.ParseException.ParseException </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The following constructors are for use by you for whatever purpose you can think of. Constructing the exception in this manner makes the exception behave in the normal way - i.e., as documented in the class "Throwable". The fields "errorToken", "expectedTokenSequences", and "tokenImage" do not contain relevant information. The JavaCC generated code does not use these constructors. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00130">130</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a18c74767ab80e1fa0025ac31890c93c8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Demo.Html.ParseException.ParseException </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>message</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00135">135</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="af301974df410cea8546231388f7ed545"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> Lucene.Net.Demo.Html.ParseException.currentToken</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00150">150</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0d7257f924881ddde3bbc94bc25467fc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int [][] Lucene.Net.Demo.Html.ParseException.expectedTokenSequences</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00156">156</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a72574dc44f52c08af7a651552aafaad3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.String [] Lucene.Net.Demo.Html.ParseException.tokenImage</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00162">162</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="ab5dcfc0a737bd3243ac31f591ddde4fc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Demo.Html.ParseException.Message</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method has the standard behavior when this object has been created using the standard constructors. Otherwise, it uses "currentToken" and "expectedTokenSequences" to generate a parse error message and returns it. If this object has been created due to a parse error, and you do not catch it (it gets thrown from the parser), then this method is called during the printing of the final stack trace, and hence the correct error message gets displayed. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html#l00047">47</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>demo/Demo.Common/HTML/<a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_parse_exception_8cs_source.html">ParseException.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:49 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
