| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface ICharStream |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface ICharStream |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="queryparser/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream"> |
| |
| |
| <h1 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream" class="text-break">Interface ICharStream |
| </h1> |
| <div class="markdown level0 summary"><p>This interface describes a character stream that maintains line and |
| column number positions of the characters. It also has the capability |
| to backup the stream to some extent. An implementation of this |
| interface is used in the TokenManager implementation generated by |
| JavaCCParser.</p> |
| <p>All the methods except <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.html#Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BackUp_System_Int32_">BackUp(Int32)</a> can be implemented in any fashion. <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.html#Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BackUp_System_Int32_">BackUp(Int32)</a> |
| needs to be implemented correctly for the correct operation of the lexer. |
| Rest of the methods are all used to get information like line number, |
| column number and the string that constitutes a token and are not used |
| by the lexer. Hence their implementation won't affect the generated lexer's |
| operation.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Parser.html">Lucene.Net.QueryParsers.Flexible.Standard.Parser</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.QueryParser.dll</h6> |
| <h5 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface ICharStream</code></pre> |
| </div> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginColumn.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginColumn%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L77">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginColumn_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginColumn*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginColumn" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginColumn">BeginColumn</h4> |
| <div class="markdown level1 summary"><p>Returns the column number of the first character for current token (being |
| matched after the last call to BeginTOken).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int BeginColumn { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginLine.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginLine%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L83">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginLine_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginLine*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginLine" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginLine">BeginLine</h4> |
| <div class="markdown level1 summary"><p>Returns the line number of the first character for current token (being |
| matched after the last call to BeginTOken).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int BeginLine { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Column.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Column%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L51">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Column_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Column*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Column" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Column">Column</h4> |
| <div class="markdown level1 summary"><p>Gets the column position of the character last read.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Obsolete] |
| int Column { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Column_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.html#Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndColumn">EndColumn</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndColumn.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.EndColumn%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L65">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndColumn_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.EndColumn*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndColumn" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.EndColumn">EndColumn</h4> |
| <div class="markdown level1 summary"><p>Returns the column number of the last character for current token (being |
| matched after the last call to BeginTOken).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int EndColumn { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndLine.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.EndLine%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L71">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndLine_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.EndLine*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndLine" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.EndLine">EndLine</h4> |
| <div class="markdown level1 summary"><p>Returns the line number of the last character for current token (being |
| matched after the last call to BeginTOken).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int EndLine { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Line.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Line%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Line_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Line*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Line" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Line">Line</h4> |
| <div class="markdown level1 summary"><p>Gets the line number of the character last read.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Obsolete] |
| int Line { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Line_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.html#Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_EndLine">EndLine</a></div> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BackUp_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BackUp(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L91">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BackUp_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BackUp*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BackUp_System_Int32_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BackUp(System.Int32)">BackUp(Int32)</h4> |
| <div class="markdown level1 summary"><p>Backs up the input stream by amount steps. Lexer calls this method if it |
| had already read some characters, but could not use them to match a |
| (longer) token. So, they will be used again as the prefix of the next |
| token and it is the implemetation's responsibility to do this right.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">void BackUp(int amount)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">amount</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginToken.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginToken%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L98">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginToken_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginToken*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BeginToken" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.BeginToken">BeginToken()</h4> |
| <div class="markdown level1 summary"><p>Returns the next character that marks the beginning of the next token. |
| All characters must remain in the buffer between two successive calls |
| to this method to implement <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.html#Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_BackUp_System_Int32_">BackUp(Int32)</a> correctly.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">char BeginToken()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Done.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Done%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L128">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Done_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Done*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_Done" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.Done">Done()</h4> |
| <div class="markdown level1 summary"><p>The lexer calls this function to indicate that it is done with the stream |
| and hence implementations can free any resources held by this class. |
| Again, the body of this function can be just empty and it will not |
| affect the lexer's operation.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">void Done()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_GetImage.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.GetImage%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L106">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_GetImage_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.GetImage*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_GetImage" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.GetImage">GetImage()</h4> |
| <div class="markdown level1 summary"><p>Returns a string made up of characters from the marked token beginning |
| to the current buffer position. Implementations have the choice of returning |
| anything that they want to. For example, for efficiency, one might decide |
| to just return null, which is a valid implementation.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string GetImage()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_GetSuffix_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.GetSuffix(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L120">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_GetSuffix_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.GetSuffix*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_GetSuffix_System_Int32_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.GetSuffix(System.Int32)">GetSuffix(Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns an array of characters that make up the suffix of length 'len' for |
| the currently matched token. This is used to build up the matched string |
| for use in actions in the case of MORE. A simple and inefficient |
| implementation of this is as follows :</p> |
| <pre><code>{ |
| string t = GetImage(); |
| return t.Substring(t.Length - len, len).ToCharArray(); |
| }</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">char[] GetSuffix(int len)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</span>[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_ReadChar.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.ReadChar%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L45">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_ReadChar_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.ReadChar*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream_ReadChar" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream.ReadChar">ReadChar()</h4> |
| <div class="markdown level1 summary"><p>Returns the next character from the selected input. The method |
| of selecting the input is the responsibility of the class |
| implementing this interface. Can throw any <span class="xref">System.IO.IOException</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">char ReadChar()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</span></td> |
| <td><p>the next character from the selected input.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_ICharStream.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.ICharStream%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/CharStream.cs/#L37" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
