Google Git
Sign in
apache / lucenenet-site / d7c714c58549c125e5d85fa5da4542fc0d56e107 / . / docs / 4.8.0-beta00007 / api / Lucene.Net / Lucene.Net.Support.C5.IQueue-1.html
blob: 1436718e7c1a25f3e09ad2292ef77e21c55e3d81 [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 IQueue&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IQueue&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Support.C5.IQueue`1">
<h1 id="Lucene_Net_Support_C5_IQueue_1" data-uid="Lucene.Net.Support.C5.IQueue`1" class="text-break">Interface IQueue&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>The interface describing the operations of a FIFO queue data structure.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IDirectedCollectionValue-1.html#Lucene_Net_Support_C5_IDirectedCollectionValue_1_Backwards">IDirectedCollectionValue&lt;T&gt;.Backwards()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IDirectedCollectionValue-1.html#Lucene_Net_Support_C5_IDirectedCollectionValue_1_FindLast_System_Func__0_System_Boolean___0__">IDirectedCollectionValue&lt;T&gt;.FindLast(Func&lt;T, Boolean&gt;, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ListenableEvents">ICollectionValue&lt;T&gt;.ListenableEvents</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ActiveEvents">ICollectionValue&lt;T&gt;.ActiveEvents</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CollectionChanged">ICollectionValue&lt;T&gt;.CollectionChanged</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CollectionCleared">ICollectionValue&lt;T&gt;.CollectionCleared</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemsAdded">ICollectionValue&lt;T&gt;.ItemsAdded</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemInserted">ICollectionValue&lt;T&gt;.ItemInserted</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemsRemoved">ICollectionValue&lt;T&gt;.ItemsRemoved</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemRemovedAt">ICollectionValue&lt;T&gt;.ItemRemovedAt</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_IsEmpty">ICollectionValue&lt;T&gt;.IsEmpty</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Count">ICollectionValue&lt;T&gt;.Count</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CountSpeed">ICollectionValue&lt;T&gt;.CountSpeed</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CopyTo__0___System_Int32_">ICollectionValue&lt;T&gt;.CopyTo(T[], Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ToArray">ICollectionValue&lt;T&gt;.ToArray()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Apply_System_Action__0__">ICollectionValue&lt;T&gt;.Apply(Action&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Exists_System_Func__0_System_Boolean__">ICollectionValue&lt;T&gt;.Exists(Func&lt;T, Boolean&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Find_System_Func__0_System_Boolean___0__">ICollectionValue&lt;T&gt;.Find(Func&lt;T, Boolean&gt;, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_All_System_Func__0_System_Boolean__">ICollectionValue&lt;T&gt;.All(Func&lt;T, Boolean&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Choose">ICollectionValue&lt;T&gt;.Choose()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Filter_System_Func__0_System_Boolean__">ICollectionValue&lt;T&gt;.Filter(Func&lt;T, Boolean&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IShowable.html#Lucene_Net_Support_C5_IShowable_Show_System_Text_StringBuilder_System_Int32__System_IFormatProvider_">IShowable.Show(StringBuilder, Int32, IFormatProvider)</a>
</div>
<div>
<span class="xref">System.IFormattable.ToString(System.String, System.IFormatProvider)</span>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IDirectedEnumerable-1.html#Lucene_Net_Support_C5_IDirectedEnumerable_1_Direction">IDirectedEnumerable&lt;T&gt;.Direction</a>
</div>
<div>
<span class="xref">System.Collections.Generic.IEnumerable&lt;T&gt;.GetEnumerator()</span>
</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_IQueue_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IQueue&lt;T&gt; : IDirectedCollectionValue&lt;T&gt;, ICollectionValue&lt;T&gt;, IShowable, IFormattable, IDirectedEnumerable&lt;T&gt;, IEnumerable&lt;T&gt;, IEnumerable</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><p>The item type</p>
</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_IQueue_1_AllowsDuplicates.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IQueue%601.AllowsDuplicates%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/#L6459">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_IQueue_1_AllowsDuplicates_" data-uid="Lucene.Net.Support.C5.IQueue`1.AllowsDuplicates*"></a>
<h4 id="Lucene_Net_Support_C5_IQueue_1_AllowsDuplicates" data-uid="Lucene.Net.Support.C5.IQueue`1.AllowsDuplicates">AllowsDuplicates</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 AllowsDuplicates { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<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_IQueue_1_Item_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IQueue%601.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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L6465">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_IQueue_1_Item_" data-uid="Lucene.Net.Support.C5.IQueue`1.Item*"></a>
<h4 id="Lucene_Net_Support_C5_IQueue_1_Item_System_Int32_" data-uid="Lucene.Net.Support.C5.IQueue`1.Item(System.Int32)">Item[Int32]</h4>
<div class="markdown level1 summary"><p>Get the <pre><code>index</code></pre>&apos;th element of the queue. The front of the queue has index 0.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T this[int index] { get; }</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">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_IQueue_1_Dequeue.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IQueue%601.Dequeue%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/#L6475">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_IQueue_1_Dequeue_" data-uid="Lucene.Net.Support.C5.IQueue`1.Dequeue*"></a>
<h4 id="Lucene_Net_Support_C5_IQueue_1_Dequeue" data-uid="Lucene.Net.Support.C5.IQueue`1.Dequeue">Dequeue()</h4>
<div class="markdown level1 summary"><p>Dequeue an item from the front of the queue.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T Dequeue()</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><p>The 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_IQueue_1_Enqueue__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IQueue%601.Enqueue(%600)%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/#L6470">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_IQueue_1_Enqueue_" data-uid="Lucene.Net.Support.C5.IQueue`1.Enqueue*"></a>
<h4 id="Lucene_Net_Support_C5_IQueue_1_Enqueue__0_" data-uid="Lucene.Net.Support.C5.IQueue`1.Enqueue(`0)">Enqueue(T)</h4>
<div class="markdown level1 summary"><p>Enqueue an item at the back of the queue. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void Enqueue(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">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item</p>
</td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="Lucene.Net.Support.EnumerableExtensions.html#Lucene_Net_Support_EnumerableExtensions_InPairs__2_System_Collections_Generic_IEnumerable___0__System_Func___0___0___1__">EnumerableExtensions.InPairs&lt;T, TOut&gt;(IEnumerable&lt;T&gt;, Func&lt;T, T, TOut&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.EnumerableExtensions.html#Lucene_Net_Support_EnumerableExtensions_TakeAllButLast__1_System_Collections_Generic_IEnumerable___0__">EnumerableExtensions.TakeAllButLast&lt;T&gt;(IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.EnumerableExtensions.html#Lucene_Net_Support_EnumerableExtensions_TakeAllButLast__1_System_Collections_Generic_IEnumerable___0__System_Int32_">EnumerableExtensions.TakeAllButLast&lt;T&gt;(IEnumerable&lt;T&gt;, Int32)</a>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_IQueue_1.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IQueue%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/#L6453" 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>