| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface ICharTermAttribute |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface ICharTermAttribute |
| | 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="core/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.TokenAttributes.ICharTermAttribute"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute" class="text-break">Interface ICharTermAttribute |
| </h1> |
| <div class="markdown level0 summary"><p>The term text of a <a class="xref" href="Lucene.Net.Analysis.Token.html">Token</a>.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.IAttribute.html#Lucene_Net_Util_IAttribute_CopyTo_Lucene_Net_Util_IAttribute_">IAttribute.CopyTo(IAttribute)</a> |
| </div> |
| <div> |
| <span class="xref">J2N.Text.ICharSequence.Subsequence(System.Int32, System.Int32)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Text.ICharSequence.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Text.ICharSequence.HasValue</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.html">Lucene.Net.Analysis.TokenAttributes</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface ICharTermAttribute : IAttribute, ICharSequence, IAppendable</code></pre> |
| </div> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Buffer.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Buffer%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/TokenAttributes/ICharTermAttribute.cs/#L51">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Buffer_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Buffer*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Buffer" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Buffer">Buffer</h4> |
| <div class="markdown level1 summary"><p>Returns the internal termBuffer character array which |
| you can then directly alter. If the array is too |
| small for your token, use <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_ResizeBuffer_System_Int32_">ResizeBuffer(Int32)</a> |
| to increase it. After |
| altering the buffer be sure to call <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_SetLength_System_Int32_">SetLength(Int32)</a> |
| to record the number of valid |
| characters that were placed into the termBuffer. |
| <p> |
| <strong>NOTE</strong>: The returned buffer may be larger than |
| the valid <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Length">Length</a>. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">char[] Buffer { 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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Item_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Item(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/TokenAttributes/ICharTermAttribute.cs/#L68">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Item_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Item*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Item_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Item(System.Int32)">Item[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">char this[int index] { get; set; }</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">index</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Length.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Length%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/TokenAttributes/ICharTermAttribute.cs/#L65">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Length_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Length*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Length" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Length">Length</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the number of valid characters (in |
| the termBuffer array. |
| <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_SetLength_System_Int32_">SetLength(Int32)</a></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int Length { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_TokenAttributes_ICharTermAttribute_Append_J2N_Text_ICharSequence_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(J2N.Text.ICharSequence)%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/TokenAttributes/ICharTermAttribute.cs/#L102">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_J2N_Text_ICharSequence_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(J2N.Text.ICharSequence)">Append(ICharSequence)</h4> |
| <div class="markdown level1 summary"><p>Appends the contents of the <span class="xref">J2N.Text.ICharSequence</span> to this character sequence. |
| <p> |
| The characters of the <span class="xref">J2N.Text.ICharSequence</span> argument are appended, in order, increasing the length of |
| this sequence by the length of the argument. If <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>, this method is a no-op. |
| <p> |
| IMPORTANT: This method uses .NET semantics. In Lucene, a <code>null</code> <code data-dev-comment-type="paramref" class="paramref">value</code> would append the |
| string <code>"null"</code> to the instance, but in Lucene.NET a <code>null</code> value will be ignored.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(ICharSequence value)</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">J2N.Text.ICharSequence</span></td> |
| <td><span class="parametername">value</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></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_TokenAttributes_ICharTermAttribute_Append_J2N_Text_ICharSequence_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(J2N.Text.ICharSequence%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/TokenAttributes/ICharTermAttribute.cs/#L129">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_J2N_Text_ICharSequence_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(J2N.Text.ICharSequence,System.Int32,System.Int32)">Append(ICharSequence, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Appends the a string representation of the specified <span class="xref">J2N.Text.ICharSequence</span> to this instance. |
| <p> |
| The characters of the <span class="xref">J2N.Text.ICharSequence</span> argument are appended, in order, increasing the length of |
| this sequence by the length of <code data-dev-comment-type="paramref" class="paramref">count</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code> |
| and <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not 0, an |
| <span class="xref">System.ArgumentNullException</span> is thrown. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(ICharSequence value, int startIndex, 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">J2N.Text.ICharSequence</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>The sequence of characters to append.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">startIndex</span></td> |
| <td><p>The start index of the <span class="xref">J2N.Text.ICharSequence</span> to begin copying characters.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">count</span></td> |
| <td><p>The number of characters to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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.ArgumentNullException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>, and |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not zero.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentOutOfRangeException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">count</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> + <code data-dev-comment-type="paramref" class="paramref">count</code> is greater than the length of <code data-dev-comment-type="paramref" class="paramref">value</code>.</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_TokenAttributes_ICharTermAttribute_Append_Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute)%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/TokenAttributes/ICharTermAttribute.cs/#L283">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute)">Append(ICharTermAttribute)</h4> |
| <div class="markdown level1 summary"><p>Appends the contents of the other <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a> to this character sequence. |
| <p>The characters of the <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a> argument are appended, in order, increasing the length of |
| this sequence by the length of the argument. If argument is <code>null</code>, this method is a no-op. |
| <p> |
| This method uses .NET semantics. In Lucene, a <code>null</code> <code data-dev-comment-type="paramref" class="paramref">value</code> would append the |
| string <code>"null"</code> to the instance, but in Lucene.NET a <code>null</code> value will be safely ignored.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(ICharTermAttribute value)</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.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>The sequence of characters to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></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_TokenAttributes_ICharTermAttribute_Append_System_Char_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs/#L135">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Char_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Char)">Append(Char)</h4> |
| <div class="markdown level1 summary"><p>Appends the supplied <span class="xref">System.Char</span> to this character sequence.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(char value)</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">value</span></td> |
| <td><p>The <span class="xref">System.Char</span> to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></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_TokenAttributes_ICharTermAttribute_Append_System_Char___.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs/#L151">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Char___" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Char[])">Append(Char[])</h4> |
| <div class="markdown level1 summary"><p>Appends the contents of the <span class="xref">char[]</span> array to this character sequence. |
| <p> |
| The characters of the <span class="xref">char[]</span> argument are appended, in order, increasing the length of |
| this sequence by the length of the <code data-dev-comment-type="paramref" class="paramref">value</code>. |
| If <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>, this method is a no-op. |
| <p> |
| This method uses .NET semantics. In Lucene, a <code>null</code> <code data-dev-comment-type="paramref" class="paramref">value</code> would append the |
| string <code>"null"</code> to the instance, but in Lucene.NET a <code>null</code> value will be safely ignored.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(char[] value)</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">value</span></td> |
| <td><p>The <span class="xref">char[]</span> array to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Char____remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>LUCENENET specific method, added to simulate using the CharBuffer class in Java.</p> |
| </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_TokenAttributes_ICharTermAttribute_Append_System_Char___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(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/TokenAttributes/ICharTermAttribute.cs/#L182">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Char[],System.Int32,System.Int32)">Append(Char[], Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Appends the string representation of the <span class="xref">char[]</span> array to this instance. |
| <p> |
| The characters of the <span class="xref">char[]</span> argument are appended, in order, increasing the length of |
| this sequence by the length of the <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code> |
| and <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not 0, an |
| <span class="xref">System.ArgumentNullException</span> is thrown. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(char[] value, int startIndex, 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">value</span></td> |
| <td><p>The sequence of characters to append.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">startIndex</span></td> |
| <td><p>The start index of the <span class="xref">char[]</span> to begin copying characters.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">count</span></td> |
| <td><p>The number of characters to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Char___System_Int32_System_Int32__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>LUCENENET specific method, added to simulate using the CharBuffer class in Java. Note that |
| the <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_CopyBuffer_System_Char___System_Int32_System_Int32_">CopyBuffer(Char[], Int32, Int32)</a> method provides similar functionality.</p> |
| </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.ArgumentNullException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>, and |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not zero.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentOutOfRangeException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">count</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> + <code data-dev-comment-type="paramref" class="paramref">count</code> is greater than the length of <code data-dev-comment-type="paramref" class="paramref">value</code>.</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_TokenAttributes_ICharTermAttribute_Append_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs/#L199">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_String_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.String)">Append(String)</h4> |
| <div class="markdown level1 summary"><p>Appends the specified <span class="xref">System.String</span> to this character sequence. |
| <p> |
| The characters of the <span class="xref">System.String</span> argument are appended, in order, increasing the length of |
| this sequence by the length of the argument. If argument is <code>null</code>, this method is a no-op. |
| <p> |
| This method uses .NET semantics. In Lucene, a <code>null</code> <code data-dev-comment-type="paramref" class="paramref">value</code> would append the |
| string <code>"null"</code> to the instance, but in Lucene.NET a <code>null</code> value will be safely ignored. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(string value)</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.String</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>The sequence of characters to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_String__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>LUCENENET specific method, added because the .NET <span class="xref">System.String</span> data type |
| doesn't implement <span class="xref">J2N.Text.ICharSequence</span>. </p> |
| </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_TokenAttributes_ICharTermAttribute_Append_System_String_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.String%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/TokenAttributes/ICharTermAttribute.cs/#L230">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_String_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.String,System.Int32,System.Int32)">Append(String, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Appends the contents of the <span class="xref">System.String</span> to this character sequence. |
| <p> |
| The characters of the <span class="xref">System.String</span> argument are appended, in order, increasing the length of |
| this sequence by the length of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code> |
| and <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not 0, an |
| <span class="xref">System.ArgumentNullException</span> is thrown. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(string value, int startIndex, 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.String</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>The sequence of characters to append.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">startIndex</span></td> |
| <td><p>The start index of the <span class="xref">System.String</span> to begin copying characters.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">count</span></td> |
| <td><p>The number of characters to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_String_System_Int32_System_Int32__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>LUCENENET specific method, added because the .NET <span class="xref">System.String</span> data type |
| doesn't implement <span class="xref">J2N.Text.ICharSequence</span>. </p> |
| </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.ArgumentNullException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>, and |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not zero.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentOutOfRangeException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">count</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> + <code data-dev-comment-type="paramref" class="paramref">count</code> is greater than the length of <code data-dev-comment-type="paramref" class="paramref">value</code>.</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_TokenAttributes_ICharTermAttribute_Append_System_Text_StringBuilder_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Text.StringBuilder)%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/TokenAttributes/ICharTermAttribute.cs/#L243">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Text_StringBuilder_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Text.StringBuilder)">Append(StringBuilder)</h4> |
| <div class="markdown level1 summary"><p>Appends a string representation of the specified <span class="xref">System.Text.StringBuilder</span> to this character sequence. |
| <p> |
| The characters of the <span class="xref">System.Text.StringBuilder</span> argument are appended, in order, increasing the length of |
| this sequence by the length of the argument. If argument is <code>null</code>, this method is a no-op. |
| <p> |
| This method uses .NET semantics. In Lucene, a <code>null</code> <code data-dev-comment-type="paramref" class="paramref">value</code> would append the |
| string <code>"null"</code> to the instance, but in Lucene.NET a <code>null</code> value will be safely ignored. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(StringBuilder value)</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.Text.StringBuilder</span></td> |
| <td><span class="parametername">value</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></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_TokenAttributes_ICharTermAttribute_Append_System_Text_StringBuilder_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Text.StringBuilder%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/TokenAttributes/ICharTermAttribute.cs/#L272">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Text_StringBuilder_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.Append(System.Text.StringBuilder,System.Int32,System.Int32)">Append(StringBuilder, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Appends a string representation of the specified <span class="xref">System.Text.StringBuilder</span> to this character sequence. |
| <p>The characters of the <span class="xref">System.Text.StringBuilder</span> argument are appended, in order, increasing the length of |
| this sequence by the length of the argument. If <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code> |
| and <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not 0, an |
| <span class="xref">System.ArgumentNullException</span> is thrown.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute Append(StringBuilder value, int startIndex, 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.Text.StringBuilder</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>The sequence of characters to append.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">startIndex</span></td> |
| <td><p>The start index of the <span class="xref">System.Text.StringBuilder</span> to begin copying characters.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">count</span></td> |
| <td><p>The number of characters to append.</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Append_System_Text_StringBuilder_System_Int32_System_Int32__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>LUCENENET specific method, added because the .NET <span class="xref">System.Text.StringBuilder</span> data type |
| doesn't implement <span class="xref">J2N.Text.ICharSequence</span>.</p> |
| </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.ArgumentNullException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>, and |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> and <code data-dev-comment-type="paramref" class="paramref">count</code> are not zero.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentOutOfRangeException</span></td> |
| <td><p><code data-dev-comment-type="paramref" class="paramref">count</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> is less than zero. |
| <p> |
| -or- |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">startIndex</code> + <code data-dev-comment-type="paramref" class="paramref">count</code> is greater than the length of <code data-dev-comment-type="paramref" class="paramref">value</code>.</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_TokenAttributes_ICharTermAttribute_CopyBuffer_System_Char___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.CopyBuffer(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/TokenAttributes/ICharTermAttribute.cs/#L36">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_CopyBuffer_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.CopyBuffer*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_CopyBuffer_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.CopyBuffer(System.Char[],System.Int32,System.Int32)">CopyBuffer(Char[], Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Copies the contents of buffer, starting at offset for |
| length characters, into the termBuffer array. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">void CopyBuffer(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 buffer to copy </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">offset</span></td> |
| <td><p>the index in the buffer of the first character to copy </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">length</span></td> |
| <td><p>the number of characters to copy </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_TokenAttributes_ICharTermAttribute_ResizeBuffer_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.ResizeBuffer(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/TokenAttributes/ICharTermAttribute.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_ResizeBuffer_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.ResizeBuffer*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_ResizeBuffer_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.ResizeBuffer(System.Int32)">ResizeBuffer(Int32)</h4> |
| <div class="markdown level1 summary"><p>Grows the termBuffer to at least size <code data-dev-comment-type="paramref" class="paramref">newSize</code>, preserving the |
| existing content. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">char[] ResizeBuffer(int newSize)</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">newSize</span></td> |
| <td><p>minimum size of the new termBuffer </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.Char</span>[]</td> |
| <td><p>newly created termBuffer with length >= newSize </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_TokenAttributes_ICharTermAttribute_SetEmpty.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.SetEmpty%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/TokenAttributes/ICharTermAttribute.cs/#L89">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_SetEmpty_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.SetEmpty*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_SetEmpty" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.SetEmpty">SetEmpty()</h4> |
| <div class="markdown level1 summary"><p>Sets the length of the termBuffer to zero. |
| Use this method before appending contents.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute SetEmpty()</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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></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_TokenAttributes_ICharTermAttribute_SetLength_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.SetLength(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/TokenAttributes/ICharTermAttribute.cs/#L83">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_SetLength_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.SetLength*"></a> |
| <h4 id="Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_SetLength_System_Int32_" data-uid="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.SetLength(System.Int32)">SetLength(Int32)</h4> |
| <div class="markdown level1 summary"><p>Set number of valid characters (length of the term) in |
| the termBuffer array. Use this to truncate the termBuffer |
| or to synchronize with external manipulation of the termBuffer. |
| Note: to grow the size of the array, |
| use <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_ResizeBuffer_System_Int32_">ResizeBuffer(Int32)</a> first. |
| NOTE: This is exactly the same operation as calling the <a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html#Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute_Length">Length</a> setter, the primary |
| difference is that this method returns a reference to the current object so it can be chained.</p> |
| <pre><code>obj.SetLength(30).Append("hey you");</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">ICharTermAttribute SetLength(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.Int32</span></td> |
| <td><span class="parametername">length</span></td> |
| <td><p>the truncated length </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><a class="xref" href="Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute.html">ICharTermAttribute</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_TokenAttributes_ICharTermAttribute.md&value=---%0Auid%3A%20Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute%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/TokenAttributes/ICharTermAttribute.cs/#L28" 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> |
