blob: e588a3433f41846e2efd86220f67f92e9ab6e602 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class BufferedCharFilter
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class BufferedCharFilter
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.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="analysis-common/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">
<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.Analysis.Util.BufferedCharFilter">
<h1 id="Lucene_Net_Analysis_Util_BufferedCharFilter" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter" class="text-break">Class BufferedCharFilter
</h1>
<div class="markdown level0 summary"><p>LUCENENET specific class to mimic Java&apos;s BufferedReader (that is, a reader that is seekable)
so it supports Mark() and Reset() (which are part of the Java Reader class), but also
provide the Correct() method of BaseCharFilter.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.MarshalByRefObject</span></div>
<div class="level2"><span class="xref">System.IO.TextReader</span></div>
<div class="level3"><span class="xref">Lucene.Net.Analysis.CharFilter</span></div>
<div class="level4"><a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html">BaseCharFilter</a></div>
<div class="level5"><span class="xref">BufferedCharFilter</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_Correct_System_Int32_">BaseCharFilter.Correct(Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_LastCumulativeDiff">BaseCharFilter.LastCumulativeDiff</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_AddOffCorrectMap_System_Int32_System_Int32_">BaseCharFilter.AddOffCorrectMap(Int32, Int32)</a>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.m_input</span>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_CorrectOffset_System_Int32_">CharFilter.CorrectOffset(Int32)</a>
</div>
<div>
<span class="xref">System.IO.TextReader.Null</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Dispose()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Synchronized(System.IO.TextReader)</span>
</div>
<div>
<span class="xref">System.MarshalByRefObject.GetLifetimeService()</span>
</div>
<div>
<span class="xref">System.MarshalByRefObject.MemberwiseClone(System.Boolean)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Util.html">Lucene.Net.Analysis.Util</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6>
<h5 id="Lucene_Net_Analysis_Util_BufferedCharFilter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BufferedCharFilter : BaseCharFilter, IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter__ctor_System_IO_TextReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.%23ctor(System.IO.TextReader)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L84">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter__ctor_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter__ctor_System_IO_TextReader_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.#ctor(System.IO.TextReader)">BufferedCharFilter(TextReader)</h4>
<div class="markdown level1 summary"><p>Creates a buffering character-input stream that uses a default-sized input buffer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BufferedCharFilter(TextReader in)</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.IO.TextReader</span></td>
<td><span class="parametername">in</span></td>
<td><p>A TextReader</p>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter__ctor_System_IO_TextReader_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.%23ctor(System.IO.TextReader%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L96">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter__ctor_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter__ctor_System_IO_TextReader_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.#ctor(System.IO.TextReader,System.Int32)">BufferedCharFilter(TextReader, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a buffering character-input stream that uses an input buffer of the specified size.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BufferedCharFilter(TextReader in, int size)</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.IO.TextReader</span></td>
<td><span class="parametername">in</span></td>
<td><p>A TextReader</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">size</span></td>
<td><p>Input-buffer size</p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_DEFAULT_CHAR_BUFFER_SIZE.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.DEFAULT_CHAR_BUFFER_SIZE%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L36">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_DEFAULT_CHAR_BUFFER_SIZE" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.DEFAULT_CHAR_BUFFER_SIZE">DEFAULT_CHAR_BUFFER_SIZE</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const int DEFAULT_CHAR_BUFFER_SIZE = 8192</code></pre>
</div>
<h5 class="fieldValue">Field 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_m_lock.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.m_lock%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L41">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_m_lock" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.m_lock">m_lock</h4>
<div class="markdown level1 summary"><p>The object used to synchronize access to the reader.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected object m_lock</code></pre>
</div>
<h5 class="fieldValue">Field 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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_IsMarkSupported.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.IsMarkSupported%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L241">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_IsMarkSupported_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.IsMarkSupported*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_IsMarkSupported" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.IsMarkSupported">IsMarkSupported</h4>
<div class="markdown level1 summary"><p>Indicates whether this reader supports the <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_">Mark(Int32)</a> and
<a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Reset">Reset()</a> methods. This implementation returns <code>true</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool IsMarkSupported { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Analysis.CharFilter.IsMarkSupported</span></div>
<h5 id="Lucene_Net_Analysis_Util_BufferedCharFilter_IsMarkSupported_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_">Mark(Int32)</a></div>
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Reset">Reset()</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_IsReady.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.IsReady%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L486">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_IsReady_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.IsReady*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_IsReady" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.IsReady">IsReady</h4>
<div class="markdown level1 summary"><p>Indicates whether this reader is ready to be read without blocking.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool IsReady { 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.Boolean</span></td>
<td><p><code>true</code> if this reader will not block when <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Read">Read()</a> is
called, <code>false</code> if unknown or blocking will occur.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Analysis.CharFilter.IsReady</span></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Close.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Close%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L616">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Close_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Close*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Close" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Close">Close()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Close()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.Close()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Dispose(System.Boolean)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L114">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Dispose_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Dispose*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Dispose_System_Boolean_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary"><p>Disposes this reader. This implementation closes the buffered source reader
and releases the buffer. Nothing is done if this reader has already been
disposed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override void Dispose(bool disposing)</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.Boolean</span></td>
<td><span class="parametername">disposing</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Dispose_System_Boolean_">CharFilter.Dispose(Boolean)</a></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if an error occurs while closing this reader.</p>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_InitializeLifetimeService.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.InitializeLifetimeService%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L611">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_InitializeLifetimeService_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.InitializeLifetimeService*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_InitializeLifetimeService" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.InitializeLifetimeService">InitializeLifetimeService()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override object InitializeLifetimeService()</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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.MarshalByRefObject.InitializeLifetimeService()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Mark(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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L221">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Mark*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Mark(System.Int32)">Mark(Int32)</h4>
<div class="markdown level1 summary"><p>Sets a mark position in this reader. The parameter <code data-dev-comment-type="paramref" class="paramref">markLimit</code>
indicates how many characters can be read before the mark is invalidated.
Calling <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Reset">Reset()</a> will reposition the reader back to the marked
position if <span class="xref">Lucene.Net.Analysis.Util.BufferedCharFilter.markLimit</span> has not been surpassed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Mark(int markLimit)</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">markLimit</span></td>
<td><p>the number of characters that can be read before the mark is
invalidated.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Mark_System_Int32_">CharFilter.Mark(Int32)</a></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
<td><p>if <code>markLimit &lt; 0</code></p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if an error occurs while setting a mark in this reader.</p>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Peek.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Peek%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L576">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Peek_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Peek*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Peek" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Peek">Peek()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Peek()</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.Peek()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Read.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Read%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L253">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Read_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Read*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Read" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Read">Read()</h4>
<div class="markdown level1 summary"><p>Reads a single character from this reader and returns it with the two
higher-order bytes set to 0. If possible, <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html">BufferedCharFilter</a> returns a
character from the buffer. If there are no characters available in the
buffer, it fills the buffer and then returns a character. It returns -1
if there are no more characters in the source reader.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Read()</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.Int32</span></td>
<td><p>The character read or -1 if the end of the source reader has been reached.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Analysis.CharFilter.Read()</span></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>If this reader is disposed or some other I/O error occurs.</p>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Read_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Read(System.Char%5B%5D%2CSystem.Int32%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L286">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Read_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Read*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Read_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Read(System.Char[],System.Int32,System.Int32)">Read(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Reads at most <code data-dev-comment-type="paramref" class="paramref">length</code> characters from this reader and stores them
at <code data-dev-comment-type="paramref" class="paramref">offset</code> in the character array <code data-dev-comment-type="paramref" class="paramref">buffer</code>. Returns the
number of characters actually read or -1 if the end of the source reader
has been reached. If all the buffered characters have been used, a mark
has not been set and the requested number of characters is larger than
this readers buffer size, BufferedReader bypasses the buffer and simply
places the results directly into <code data-dev-comment-type="paramref" class="paramref">buffer</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Read(char[] buffer, int offset, int length)</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.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td><p>the character array to store the characters read.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">offset</span></td>
<td><p>the initial position in <code data-dev-comment-type="paramref" class="paramref">buffer</code> to store the bytes read from this reader.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">length</span></td>
<td><p>the maximum number of characters to read, must be non-negative.</p>
</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.Int32</span></td>
<td><p>number of characters read or -1 if the end of the source reader has been reached.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Read_System_Char___System_Int32_System_Int32_">CharFilter.Read(Char[], Int32, Int32)</a></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
<td><p>if <code>offset &lt; 0</code> or <code>length &lt; 0</code>, or if
<code>offset + length</code> is greater than the size of
<code data-dev-comment-type="paramref" class="paramref">buffer</code>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if this reader is disposed or some other I/O error occurs.</p>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadAsync_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadAsync(System.Char%5B%5D%2CSystem.Int32%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L581">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadAsync_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadAsync*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadAsync_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadAsync(System.Char[],System.Int32,System.Int32)">ReadAsync(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;int&gt; ReadAsync(char[] buffer, int index, int count)</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.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</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.Threading.Tasks.Task</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadBlock_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadBlock(System.Char%5B%5D%2CSystem.Int32%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L586">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadBlock_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadBlock*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadBlock_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadBlock(System.Char[],System.Int32,System.Int32)">ReadBlock(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int ReadBlock(char[] buffer, int index, int count)</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.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadBlock(System.Char[], System.Int32, System.Int32)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadBlockAsync_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadBlockAsync(System.Char%5B%5D%2CSystem.Int32%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L591">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadBlockAsync_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadBlockAsync*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadBlockAsync_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadBlockAsync(System.Char[],System.Int32,System.Int32)">ReadBlockAsync(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;int&gt; ReadBlockAsync(char[] buffer, int index, int count)</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.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</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.Threading.Tasks.Task</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.Int32)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadLine.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadLine%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L380">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadLine_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadLine*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadLine" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadLine">ReadLine()</h4>
<div class="markdown level1 summary"><p>Returns the next line of text available from this reader. A line is
represented by zero or more characters followed by <code>&apos;\n&apos;</code>,
<code>&apos;\r&apos;</code>, <code>&quot;\r\n&quot;</code> or the end of the reader. The string does
not include the newline sequence.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ReadLine()</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><p>The contents of the line or <code>null</code> if no characters were
read before the end of the reader has been reached.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadLine()</span></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if this reader is disposed or some other I/O error occurs.</p>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadLineAsync.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadLineAsync%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L596">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadLineAsync_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadLineAsync*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadLineAsync" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadLineAsync">ReadLineAsync()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;string&gt; ReadLineAsync()</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.Threading.Tasks.Task</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadLineAsync()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadToEnd.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadToEnd%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L601">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadToEnd_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadToEnd*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadToEnd" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadToEnd">ReadToEnd()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ReadToEnd()</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>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadToEnd()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_ReadToEndAsync.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.ReadToEndAsync%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L606">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadToEndAsync_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadToEndAsync*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_ReadToEndAsync" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.ReadToEndAsync">ReadToEndAsync()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;string&gt; ReadToEndAsync()</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.Threading.Tasks.Task</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.IO.TextReader.ReadToEndAsync()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Reset.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Reset%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L508">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Reset_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Reset*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Reset" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Reset">Reset()</h4>
<div class="markdown level1 summary"><p>Resets this reader&apos;s position to the last <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_">Mark(Int32)</a> location.
Invocations of <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Read">Read()</a> and <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Skip_System_Int32_">Skip(Int32)</a> will occur from this new
location.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Reset()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Analysis.CharFilter.Reset()</span></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>If this reader is disposed or no mark has been set.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Reset_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_">Mark(Int32)</a></div>
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_IsMarkSupported">IsMarkSupported</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter_Skip_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter.Skip(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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L534">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_BufferedCharFilter_Skip_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Skip*"></a>
<h4 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Skip_System_Int32_" data-uid="Lucene.Net.Analysis.Util.BufferedCharFilter.Skip(System.Int32)">Skip(Int32)</h4>
<div class="markdown level1 summary"><p>Skips <code data-dev-comment-type="paramref" class="paramref">amount</code> characters in this reader. Subsequent
<a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Read">Read()</a>s will not return these characters unless <a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Reset">Reset()</a>
is used. Skipping characters may invalidate a mark if <span class="xref">Lucene.Net.Analysis.Util.BufferedCharFilter.markLimit</span>
is surpassed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override long Skip(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><p>the maximum number of characters to skip.</p>
</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.Int64</span></td>
<td><p>the number of characters actually skipped.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Skip_System_Int32_">CharFilter.Skip(Int32)</a></div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ArgumentOutOfRangeException</span></td>
<td><p>if <code>amount &lt; 0</code>.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>If this reader is disposed or some other I/O error occurs.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Analysis_Util_BufferedCharFilter_Skip_System_Int32__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Mark_System_Int32_">Mark(Int32)</a></div>
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_IsMarkSupported">IsMarkSupported</a></div>
<div><a class="xref" href="Lucene.Net.Analysis.Util.BufferedCharFilter.html#Lucene_Net_Analysis_Util_BufferedCharFilter_Reset">Reset()</a></div>
</div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_BufferedCharFilter.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.BufferedCharFilter%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs/#L34" 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 Licensed to the Apache Software Foundation (ASF)
</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>