blob: d85897e92028dcf93b9a4256a12d3a671ba1bd8c [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>Interface ICollectionValue&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface ICollectionValue&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.50.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.Support.C5.ICollectionValue`1">
<h1 id="Lucene_Net_Support_C5_ICollectionValue_1" data-uid="Lucene.Net.Support.C5.ICollectionValue`1" class="text-break">Interface ICollectionValue&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>A generic collection that may be enumerated and can answer
efficiently how many items it contains. Like <pre><code>IEnumerable&lt;T></code></pre>,
this interface does not prescribe any operations to initialize or update the
collection. The main usage for this interface is to be the return type of
query operations on generic collection.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IShowable.html#Lucene_Net_Support_C5_IShowable_Show_System_Text_StringBuilder_System_Int32__IFormatProvider_">IShowable.Show(System.Text.StringBuilder, Int32, IFormatProvider)</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Support.C5.html">Lucene.Net.Support.C5</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Support_C5_ICollectionValue_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface ICollectionValue&lt;T&gt; : System.Collections.Generic.IEnumerable&lt;T&gt;, IShowable, IFormattable</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_ICollectionValue_1_ActiveEvents.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ActiveEvents%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/Support/C5.Support.cs/#L5877">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_ActiveEvents_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ActiveEvents*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ActiveEvents" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ActiveEvents">ActiveEvents</h4>
<div class="markdown level1 summary"><p>A flag bitmap of the events currently subscribed to by this collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">EventTypeEnum ActiveEvents { 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><a class="xref" href="Lucene.Net.Support.C5.EventTypeEnum.html">EventTypeEnum</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_ICollectionValue_1_Count.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.Count%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/Support/C5.Support.cs/#L5918">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_Count_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Count*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_Count" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Count">Count</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">int Count { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><p>The number of items in this collection</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_Support_C5_ICollectionValue_1_CountSpeed.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.CountSpeed%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/Support/C5.Support.cs/#L5927">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_CountSpeed_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.CountSpeed*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_CountSpeed" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.CountSpeed">CountSpeed</h4>
<div class="markdown level1 summary"><p>The value is symbolic indicating the type of asymptotic complexity
in terms of the size of this collection (worst-case or amortized as
relevant).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Speed CountSpeed { 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><a class="xref" href="Lucene.Net.Support.C5.Speed.html">Speed</a></td>
<td><p>A characterization of the speed of the </p>
<pre><code>Count</code></pre> property in this collection.</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_Support_C5_ICollectionValue_1_IsEmpty.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.IsEmpty%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/Support/C5.Support.cs/#L5913">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_IsEmpty_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.IsEmpty*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_IsEmpty" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.IsEmpty">IsEmpty</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">bool IsEmpty { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if this collection is empty.</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_Support_C5_ICollectionValue_1_ListenableEvents.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ListenableEvents%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/Support/C5.Support.cs/#L5871">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_ListenableEvents_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ListenableEvents*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ListenableEvents" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ListenableEvents">ListenableEvents</h4>
<div class="markdown level1 summary"><p>A flag bitmap of the events subscribable to by this collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">EventTypeEnum ListenableEvents { 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><a class="xref" href="Lucene.Net.Support.C5.EventTypeEnum.html">EventTypeEnum</a></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_Support_C5_ICollectionValue_1_All_Func__0_System_Boolean__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.All(Func%7B%600%2CSystem.Boolean%7D)%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/Support/C5.Support.cs/#L5976">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_All_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.All*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_All_Func__0_System_Boolean__" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.All(Func{`0,System.Boolean})">All(Func&lt;T, Boolean&gt;)</h4>
<div class="markdown level1 summary"><p>Check if all items in this collection satisfies a specific predicate.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool All(Func&lt;T, bool&gt; predicate)</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">Func</span>&lt;T, <span class="xref">System.Boolean</span>&gt;</td>
<td><span class="parametername">predicate</span></td>
<td><p>A delegate
(<span class="xref">Func&lt;, &gt;</span> with <pre><code>R == bool</code></pre>) defining the predicate</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.Boolean</span></td>
<td><p>True if all items satisfies the predicate</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_Support_C5_ICollectionValue_1_Apply_Action__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.Apply(Action%7B%600%7D)%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/Support/C5.Support.cs/#L5947">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_Apply_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Apply*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_Apply_Action__0__" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Apply(Action{`0})">Apply(Action&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>Apply a delegate to all items of this collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void Apply(Action&lt;T&gt; action)</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">Action</span>&lt;T&gt;</td>
<td><span class="parametername">action</span></td>
<td><p>The delegate to apply</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_Support_C5_ICollectionValue_1_Choose.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.Choose%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/Support/C5.Support.cs/#L5989">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_Choose_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Choose*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_Choose" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Choose">Choose()</h4>
<div class="markdown level1 summary"><p>Choose some item of this collection.
<p>Implementations must assure that the item
returned may be efficiently removed.</p>
<p>Implementors may decide to implement this method in a way such that repeated
calls do not necessarily give the same result, i.e. so that the result of the following
test is undetermined:</p>
<pre><code>coll.Choose() == coll.Choose()</code></pre></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T Choose()</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">T</span></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><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if collection is empty.</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_Support_C5_ICollectionValue_1_CopyTo__0___System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.CopyTo(%600%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/Support/C5.Support.cs/#L5934">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_CopyTo_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.CopyTo*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_CopyTo__0___System_Int32_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.CopyTo(`0[],System.Int32)">CopyTo(T[], Int32)</h4>
<div class="markdown level1 summary"><p>Copy the items of this collection to a contiguous part of an array.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void CopyTo(T[] array, int index)</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>T[]</td>
<td><span class="parametername">array</span></td>
<td><p>The array to copy to</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>The index at which to copy the first item</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_Support_C5_ICollectionValue_1_Exists_Func__0_System_Boolean__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.Exists(Func%7B%600%2CSystem.Boolean%7D)%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/Support/C5.Support.cs/#L5957">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_Exists_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Exists*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_Exists_Func__0_System_Boolean__" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Exists(Func{`0,System.Boolean})">Exists(Func&lt;T, Boolean&gt;)</h4>
<div class="markdown level1 summary"><p>Check if there exists an item that satisfies a
specific predicate in this collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool Exists(Func&lt;T, bool&gt; predicate)</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">Func</span>&lt;T, <span class="xref">System.Boolean</span>&gt;</td>
<td><span class="parametername">predicate</span></td>
<td><p>A delegate
(<span class="xref">Func&lt;, &gt;</span> with <pre><code>R == bool</code></pre>) defining the predicate</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.Boolean</span></td>
<td><p>True is such an item exists</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_Support_C5_ICollectionValue_1_Filter_Func__0_System_Boolean__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.Filter(Func%7B%600%2CSystem.Boolean%7D)%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/Support/C5.Support.cs/#L5997">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_Filter_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Filter*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_Filter_Func__0_System_Boolean__" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Filter(Func{`0,System.Boolean})">Filter(Func&lt;T, Boolean&gt;)</h4>
<div class="markdown level1 summary"><p>Create an enumerable, enumerating the items of this collection that satisfies
a certain condition.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">System.Collections.Generic.IEnumerable&lt;T&gt; Filter(Func&lt;T, bool&gt; filter)</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">Func</span>&lt;T, <span class="xref">System.Boolean</span>&gt;</td>
<td><span class="parametername">filter</span></td>
<td><p>The T-&gt;bool filter delegate defining the condition</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.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
<td><p>The filtered enumerable</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_Support_C5_ICollectionValue_1_Find_Func__0_System_Boolean___0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.Find(Func%7B%600%2CSystem.Boolean%7D%2C%600%40)%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/Support/C5.Support.cs/#L5967">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_Find_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Find*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_Find_Func__0_System_Boolean___0__" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.Find(Func{`0,System.Boolean},`0@)">Find(Func&lt;T, Boolean&gt;, out T)</h4>
<div class="markdown level1 summary"><p>Check if there exists an item that satisfies a
specific predicate in this collection and return the first one in enumeration order.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool Find(Func&lt;T, bool&gt; predicate, out T item)</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">Func</span>&lt;T, <span class="xref">System.Boolean</span>&gt;</td>
<td><span class="parametername">predicate</span></td>
<td><p>A delegate
(<span class="xref">Func&lt;, &gt;</span> with <pre><code>R == bool</code></pre>) defining the predicate</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True is such an item exists</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_Support_C5_ICollectionValue_1_ToArray.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ToArray%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/Support/C5.Support.cs/#L5941">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ICollectionValue_1_ToArray_" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ToArray*"></a>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ToArray" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ToArray">ToArray()</h4>
<div class="markdown level1 summary"><p>Create an array with the items of this collection (in the same order as an
enumerator would output them).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T[] ToArray()</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>T[]</td>
<td><p>The array</p>
</td>
</tr>
</tbody>
</table>
<h3 id="events">Events
</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_Support_C5_ICollectionValue_1_CollectionChanged.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.CollectionChanged%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/Support/C5.Support.cs/#L5882">View Source</a>
</span>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_CollectionChanged" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.CollectionChanged">CollectionChanged</h4>
<div class="markdown level1 summary"><p>The change event. Will be raised for every change operation on the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event CollectionChangedHandler&lt;T&gt; CollectionChanged</code></pre>
</div>
<h5 class="eventType">Event Type</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.Support.C5.CollectionChangedHandler-1.html">CollectionChangedHandler</a>&lt;T&gt;</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_Support_C5_ICollectionValue_1_CollectionCleared.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.CollectionCleared%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/Support/C5.Support.cs/#L5887">View Source</a>
</span>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_CollectionCleared" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.CollectionCleared">CollectionCleared</h4>
<div class="markdown level1 summary"><p>The change event. Will be raised for every clear operation on the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event CollectionClearedHandler&lt;T&gt; CollectionCleared</code></pre>
</div>
<h5 class="eventType">Event Type</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.Support.C5.CollectionClearedHandler-1.html">CollectionClearedHandler</a>&lt;T&gt;</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_Support_C5_ICollectionValue_1_ItemInserted.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ItemInserted%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/Support/C5.Support.cs/#L5897">View Source</a>
</span>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ItemInserted" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ItemInserted">ItemInserted</h4>
<div class="markdown level1 summary"><p>The item inserted event. Will be raised for every individual insertion to the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event ItemInsertedHandler&lt;T&gt; ItemInserted</code></pre>
</div>
<h5 class="eventType">Event Type</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.Support.C5.ItemInsertedHandler-1.html">ItemInsertedHandler</a>&lt;T&gt;</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_Support_C5_ICollectionValue_1_ItemRemovedAt.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ItemRemovedAt%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/Support/C5.Support.cs/#L5907">View Source</a>
</span>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ItemRemovedAt" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ItemRemovedAt">ItemRemovedAt</h4>
<div class="markdown level1 summary"><p>The item removed at event. Will be raised for every individual removal at from the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event ItemRemovedAtHandler&lt;T&gt; ItemRemovedAt</code></pre>
</div>
<h5 class="eventType">Event Type</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.Support.C5.ItemRemovedAtHandler-1.html">ItemRemovedAtHandler</a>&lt;T&gt;</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_Support_C5_ICollectionValue_1_ItemsAdded.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ItemsAdded%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/Support/C5.Support.cs/#L5892">View Source</a>
</span>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ItemsAdded" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ItemsAdded">ItemsAdded</h4>
<div class="markdown level1 summary"><p>The item added event. Will be raised for every individual addition to the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event ItemsAddedHandler&lt;T&gt; ItemsAdded</code></pre>
</div>
<h5 class="eventType">Event Type</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.Support.C5.ItemsAddedHandler-1.html">ItemsAddedHandler</a>&lt;T&gt;</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_Support_C5_ICollectionValue_1_ItemsRemoved.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601.ItemsRemoved%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/Support/C5.Support.cs/#L5902">View Source</a>
</span>
<h4 id="Lucene_Net_Support_C5_ICollectionValue_1_ItemsRemoved" data-uid="Lucene.Net.Support.C5.ICollectionValue`1.ItemsRemoved">ItemsRemoved</h4>
<div class="markdown level1 summary"><p>The item removed event. Will be raised for every individual removal from the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event ItemsRemovedHandler&lt;T&gt; ItemsRemoved</code></pre>
</div>
<h5 class="eventType">Event Type</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.Support.C5.ItemsRemovedHandler-1.html">ItemsRemovedHandler</a>&lt;T&gt;</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_ICollectionValue_1.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ICollectionValue%601%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/Support/C5.Support.cs/#L5865" 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>