blob: 43d5a1ff6d137e15fec57dc8211b565614e51fdb [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 JapaneseIterationMarkCharFilter
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class JapaneseIterationMarkCharFilter
| 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-kuromoji/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.Ja.JapaneseIterationMarkCharFilter">
<h1 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter" class="text-break">Class JapaneseIterationMarkCharFilter
</h1>
<div class="markdown level0 summary"><p>Normalizes Japanese horizontal iteration marks (odoriji) to their expanded form.</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"><span class="xref">JapaneseIterationMarkCharFilter</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>
<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_Dispose_System_Boolean_">CharFilter.Dispose(Boolean)</a>
</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>
<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>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.Reset()</span>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.IsReady</span>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.IsMarkSupported</span>
</div>
<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>
<div>
<span class="xref">System.IO.TextReader.Null</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Close()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Dispose()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Peek()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadBlock(System.Char[], System.Int32, System.Int32)</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.Int32)</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadLine()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadLineAsync()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadToEnd()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadToEndAsync()</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.InitializeLifetimeService()</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.Ja.html">Lucene.Net.Analysis.Ja</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Kuromoji.dll</h6>
<h5 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class JapaneseIterationMarkCharFilter : CharFilter, IDisposable</code></pre>
</div>
<h5 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Sequences of iteration marks are supported. In case an illegal sequence of iteration
marks is encountered, the implementation emits the illegal source character as-is
without considering its script. For example, with input &quot;?ゝ&quot;, we get
&quot;??&quot; even though &quot;?&quot; isn&apos;t hiragana.
<p>
Note that a full stop punctuation character &quot;。&quot; (U+3002) can not be iterated
(see below). Iteration marks themselves can be emitted in case they are illegal,
i.e. if they go back past the beginning of the character stream.
<p>
The implementation buffers input until a full stop punctuation character (U+3002)
or EOF is reached in order to not keep a copy of the character stream in memory.
Vertical iteration marks, which are even rarer than horizontal iteration marks in
contemporary Japanese, are unsupported.</p>
</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_Ja_JapaneseIterationMarkCharFilter__ctor_System_IO_TextReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.%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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L147">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter__ctor_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter__ctor_System_IO_TextReader_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.#ctor(System.IO.TextReader)">JapaneseIterationMarkCharFilter(TextReader)</h4>
<div class="markdown level1 summary"><p>Constructor. Normalizes both kanji and kana iteration marks by default.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JapaneseIterationMarkCharFilter(TextReader input)</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">input</span></td>
<td><p>Char stream.</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_Ja_JapaneseIterationMarkCharFilter__ctor_System_IO_TextReader_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.%23ctor(System.IO.TextReader%2CSystem.Boolean%2CSystem.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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L158">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter__ctor_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter__ctor_System_IO_TextReader_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.#ctor(System.IO.TextReader,System.Boolean,System.Boolean)">JapaneseIterationMarkCharFilter(TextReader, Boolean, Boolean)</h4>
<div class="markdown level1 summary"><p>Constructor</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JapaneseIterationMarkCharFilter(TextReader input, bool normalizeKanji, bool normalizeKana)</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">input</span></td>
<td><p>Char stream.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">normalizeKanji</span></td>
<td><p>Indicates whether kanji iteration marks should be normalized.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">normalizeKana</span></td>
<td><p>Indicates whether kana iteration marks should be normalized.</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_Ja_JapaneseIterationMarkCharFilter_NORMALIZE_KANA_DEFAULT.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.NORMALIZE_KANA_DEFAULT%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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L48">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_NORMALIZE_KANA_DEFAULT" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.NORMALIZE_KANA_DEFAULT">NORMALIZE_KANA_DEFAULT</h4>
<div class="markdown level1 summary"><p>Normalize kana iteration marks by default</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly bool NORMALIZE_KANA_DEFAULT</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.Boolean</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_Ja_JapaneseIterationMarkCharFilter_NORMALIZE_KANJI_DEFAULT.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.NORMALIZE_KANJI_DEFAULT%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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L45">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_NORMALIZE_KANJI_DEFAULT" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.NORMALIZE_KANJI_DEFAULT">NORMALIZE_KANJI_DEFAULT</h4>
<div class="markdown level1 summary"><p>Normalize kanji iteration marks by default</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly bool NORMALIZE_KANJI_DEFAULT</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<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_Ja_JapaneseIterationMarkCharFilter_Correct_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Correct(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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L495">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_Correct_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Correct*"></a>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_Correct_System_Int32_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Correct(System.Int32)">Correct(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">protected override int Correct(int currentOff)</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">currentOff</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><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Correct_System_Int32_">CharFilter.Correct(Int32)</a></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_Ja_JapaneseIterationMarkCharFilter_Read.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L205">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_Read_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Read*"></a>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_Read" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Read">Read()</h4>
<div class="markdown level1 summary"><p>Reads the next character from the text reader and advances the character position by one character.</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 next character from the text reader, or -1 if no more characters are available.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Analysis.CharFilter.Read()</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_Ja_JapaneseIterationMarkCharFilter_Read_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L183">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_Read_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Read*"></a>
<h4 id="Lucene_Net_Analysis_Ja_JapaneseIterationMarkCharFilter_Read_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.Read(System.Char[],System.Int32,System.Int32)">Read(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.</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>When this method returns, contains the specified character array with the values between index and (index + count - 1)
replaced by the characters read from the current source.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">offset</span></td>
<td><p>The position in buffer at which to begin writing.</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. If the end of the reader is reached before the specified number of characters is
read into the buffer, the method returns.</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>The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is
available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.</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>
<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_Ja_JapaneseIterationMarkCharFilter.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter%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.Kuromoji/JapaneseIterationMarkCharFilter.cs/#L42" 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>