blob: b49214f61d5910a45053ee5413d6b547a56eb901 [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 ReverseStringFilter
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ReverseStringFilter
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</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="../../index.html">
<img id="logo" class="svg" src="../../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" id="breadcrumb">
<ul class="breadcrumb">
<li></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.Reverse.ReverseStringFilter">
<h1 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter" class="text-break">Class ReverseStringFilter
</h1>
<div class="markdown level0 summary"><p>Reverse token string, for example &quot;country&quot; =&gt; &quot;yrtnuoc&quot;.
<p>
If <span class="xref">Lucene.Net.Analysis.Reverse.ReverseStringFilter.marker</span> is supplied, then tokens will be also prepended by
that character. For example, with a marker of \u0001, &quot;country&quot; =&gt;
&quot;\u0001yrtnuoc&quot;. This is useful when implementing efficient leading
wildcards search.
</p>
<p>You must specify the required <a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a>
compatibility when creating <a class="xref" href="Lucene.Net.Analysis.Reverse.ReverseStringFilter.html">ReverseStringFilter</a>, or when using any of
its static methods:
<ul><li> As of 3.1, supplementary characters are handled correctly</li></ul>
</p></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"><a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html">AttributeSource</a></div>
<div class="level2"><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a></div>
<div class="level3"><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenFilter.html">TokenFilter</a></div>
<div class="level4"><span class="xref">ReverseStringFilter</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/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_m_input">TokenFilter.m_input</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_End">TokenFilter.End()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_Dispose_System_Boolean_">TokenFilter.Dispose(Boolean)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_Reset">TokenFilter.Reset()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html#Lucene_Net_Analysis_TokenStream_Dispose">TokenStream.Dispose()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttributeFactory">AttributeSource.GetAttributeFactory()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttributeClassesEnumerator">AttributeSource.GetAttributeClassesEnumerator()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttributeImplsEnumerator">AttributeSource.GetAttributeImplsEnumerator()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_AddAttributeImpl_Lucene_Net_Util_Attribute_">AttributeSource.AddAttributeImpl(Attribute)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_AddAttribute__1">AttributeSource.AddAttribute&lt;T&gt;()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_HasAttributes">AttributeSource.HasAttributes</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_HasAttribute__1">AttributeSource.HasAttribute&lt;T&gt;()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttribute__1">AttributeSource.GetAttribute&lt;T&gt;()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ClearAttributes">AttributeSource.ClearAttributes()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_CaptureState">AttributeSource.CaptureState()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_RestoreState_Lucene_Net_Util_AttributeSource_State_">AttributeSource.RestoreState(AttributeSource.State)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetHashCode">AttributeSource.GetHashCode()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_Equals_System_Object_">AttributeSource.Equals(Object)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectAsString_System_Boolean_">AttributeSource.ReflectAsString(Boolean)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectWith_Lucene_Net_Util_IAttributeReflector_">AttributeSource.ReflectWith(IAttributeReflector)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_CloneAttributes">AttributeSource.CloneAttributes()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_CopyTo_Lucene_Net_Util_AttributeSource_">AttributeSource.CopyTo(AttributeSource)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ToString">AttributeSource.ToString()</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</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>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Reverse.html">Lucene.Net.Analysis.Reverse</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6>
<h5 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class ReverseStringFilter : TokenFilter, 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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream)%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L76">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter__ctor_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream)">ReverseStringFilter(LuceneVersion, TokenStream)</h4>
<div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Analysis.Reverse.ReverseStringFilter.html">ReverseStringFilter</a> that reverses all tokens in the
supplied <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a>.
<p>
The reversed tokens will not be marked.
</p></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ReverseStringFilter(LuceneVersion matchVersion, TokenStream 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><a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>lucene compatibility version </p>
</td>
</tr>
<tr>
<td><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a></td>
<td><span class="parametername">in</span></td>
<td><p><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a> to filter </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_System_Char_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream%2CSystem.Char)%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L92">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter__ctor_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_System_Char_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream,System.Char)">ReverseStringFilter(LuceneVersion, TokenStream, Char)</h4>
<div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Analysis.Reverse.ReverseStringFilter.html">ReverseStringFilter</a> that reverses and marks all tokens in the
supplied <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a>.
<p>
The reversed tokens will be prepended (marked) by the <code data-dev-comment-type="paramref" class="paramref">marker</code>
character.
</p></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ReverseStringFilter(LuceneVersion matchVersion, TokenStream in, char marker)</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><a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>lucene compatibility version </p>
</td>
</tr>
<tr>
<td><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a></td>
<td><span class="parametername">in</span></td>
<td><p><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a> to filter </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Char</span></td>
<td><span class="parametername">marker</span></td>
<td><p>A character used to mark reversed tokens </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_INFORMATION_SEPARATOR_MARKER.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.INFORMATION_SEPARATOR_MARKER%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L55">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_INFORMATION_SEPARATOR_MARKER" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.INFORMATION_SEPARATOR_MARKER">INFORMATION_SEPARATOR_MARKER</h4>
<div class="markdown level1 summary"><p>Example marker character: U+001F (INFORMATION SEPARATOR ONE)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const char INFORMATION_SEPARATOR_MARKER = '\u001f'</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.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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_PUA_EC00_MARKER.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.PUA_EC00_MARKER%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L60">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_PUA_EC00_MARKER" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.PUA_EC00_MARKER">PUA_EC00_MARKER</h4>
<div class="markdown level1 summary"><p>Example marker character: U+EC00 (PRIVATE USE AREA: EC00) </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const char PUA_EC00_MARKER = '&#60416;'</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.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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_RTL_DIRECTION_MARKER.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.RTL_DIRECTION_MARKER%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L65">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_RTL_DIRECTION_MARKER" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.RTL_DIRECTION_MARKER">RTL_DIRECTION_MARKER</h4>
<div class="markdown level1 summary"><p>Example marker character: U+200F (RIGHT-TO-LEFT MARK)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const char RTL_DIRECTION_MARKER = '&#8207;'</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.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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_START_OF_HEADING_MARKER.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.START_OF_HEADING_MARKER%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L50">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_START_OF_HEADING_MARKER" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.START_OF_HEADING_MARKER">START_OF_HEADING_MARKER</h4>
<div class="markdown level1 summary"><p>Example marker character: U+0001 (START OF HEADING) </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const char START_OF_HEADING_MARKER = '\u0001'</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.Char</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_IncrementToken.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.IncrementToken%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L100">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_IncrementToken_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.IncrementToken*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_IncrementToken" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.IncrementToken">IncrementToken()</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 bool IncrementToken()</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html#Lucene_Net_Analysis_TokenStream_IncrementToken">TokenStream.IncrementToken()</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_Char___.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion%2CSystem.Char%5B%5D)%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L138">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_Char___" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion,System.Char[])">Reverse(LuceneVersion, Char[])</h4>
<div class="markdown level1 summary"><p>Reverses the given input buffer in-place </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Reverse(LuceneVersion matchVersion, char[] buffer)</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><a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>lucene compatibility version </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td><p>the input char array to reverse </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_Char___System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion%2CSystem.Char%5B%5D%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L150">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_Char___System_Int32_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion,System.Char[],System.Int32)">Reverse(LuceneVersion, Char[], Int32)</h4>
<div class="markdown level1 summary"><p>Partially reverses the given input buffer in-place from offset 0
up to the given length. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Reverse(LuceneVersion matchVersion, char[] buffer, 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><a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>lucene compatibility version </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td><p>the input char array to reverse </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td><p>the length in the buffer up to where the
buffer should be reversed </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion%2CSystem.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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L180">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion,System.Char[],System.Int32,System.Int32)">Reverse(LuceneVersion, Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Partially reverses the given input buffer in-place from the given offset
up to the given length. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Reverse(LuceneVersion matchVersion, char[] buffer, int start, 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><a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>lucene compatibility version </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td><p>the input char array to reverse </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">start</span></td>
<td><p>the offset from where to reverse the buffer </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td><p>the length in the buffer up to where the
buffer should be reversed </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion%2CSystem.String)%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L127">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse*"></a>
<h4 id="Lucene_Net_Analysis_Reverse_ReverseStringFilter_Reverse_Lucene_Net_Util_LuceneVersion_System_String_" data-uid="Lucene.Net.Analysis.Reverse.ReverseStringFilter.Reverse(Lucene.Net.Util.LuceneVersion,System.String)">Reverse(LuceneVersion, String)</h4>
<div class="markdown level1 summary"><p>Reverses the given input string</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string Reverse(LuceneVersion matchVersion, string 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><a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>lucene compatibility version </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">input</span></td>
<td><p>the string to reverse </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.String</span></td>
<td><p>the given input string in reversed order </p>
</td>
</tr>
</tbody>
</table>
<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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Reverse_ReverseStringFilter.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Reverse.ReverseStringFilter%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs/#L40" 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="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>