blob: c6845b5e9c70b9ee3472d380b17190b769c424b3 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ContentItemsSource
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ContentItemsSource
| 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="benchmark/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.Benchmarks.ByTask.Feeds.ContentItemsSource">
<h1 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource" class="text-break">Class ContentItemsSource
</h1>
<div class="markdown level0 summary"><p>Base class for source of data for benchmarking.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ContentItemsSource</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Feeds.ContentSource.html">ContentSource</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Feeds.FacetSource.html">FacetSource</a></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Feeds.html">Lucene.Net.Benchmarks.ByTask.Feeds</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6>
<h5 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class ContentItemsSource : IDisposable</code></pre>
</div>
<h5 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Keeps track of various statistics, such as how many data items were generated,
size in bytes etc.
<p>
Supports the following configuration parameters:
<ul><li>content.source.foreverspecifies whether to generate items forever (<strong>default=true</strong>).</li><li>content.source.verbosespecifies whether messages should be output by the content source (<strong>default=false</strong>).</li><li>content.source.encoding
specifies which encoding to use when
reading the files of that content source. Certain implementations may define
a default value if this parameter is not specified. (<strong>default=null</strong>).
</li><li>content.source.log.step
specifies for how many items a
message should be logged. If set to 0 it means no logging should occur.
<strong>NOTE:</strong> if verbose is set to false, logging should not occur even if
logStep is not 0 (<strong>default=0</strong>).
</li></ul></p>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_m_encoding.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_encoding%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L69">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_m_encoding" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_encoding">m_encoding</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected Encoding m_encoding</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Text.Encoding</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_Benchmarks_ByTask_Feeds_ContentItemsSource_m_forever.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_forever%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L66">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_m_forever" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_forever">m_forever</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool m_forever</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_m_logStep.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_logStep%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L67">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_m_logStep" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_logStep">m_logStep</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected int m_logStep</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</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_Benchmarks_ByTask_Feeds_ContentItemsSource_m_verbose.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_verbose%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L68">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_m_verbose" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.m_verbose">m_verbose</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool m_verbose</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="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_Benchmarks_ByTask_Feeds_ContentItemsSource_BytesCount.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.BytesCount%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L142">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_BytesCount_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.BytesCount*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_BytesCount" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.BytesCount">BytesCount</h4>
<div class="markdown level1 summary"><p>Returns the number of bytes generated since last reset.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long BytesCount { 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.Int64</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_Benchmarks_ByTask_Feeds_ContentItemsSource_Config.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Config%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L147">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_Config_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Config*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_Config" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Config">Config</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Config Config { 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.Benchmarks.ByTask.Utils.Config.html">Config</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_Benchmarks_ByTask_Feeds_ContentItemsSource_ItemsCount.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ItemsCount%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L145">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_ItemsCount_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ItemsCount*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_ItemsCount" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ItemsCount">ItemsCount</h4>
<div class="markdown level1 summary"><p>Returns the number of generated items since last reset.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ItemsCount { 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></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_Benchmarks_ByTask_Feeds_ContentItemsSource_TotalBytesCount.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.TotalBytesCount%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L150">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_TotalBytesCount_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.TotalBytesCount*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_TotalBytesCount" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.TotalBytesCount">TotalBytesCount</h4>
<div class="markdown level1 summary"><p>Returns the total number of bytes that were generated by this source.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long TotalBytesCount { 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.Int64</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_Benchmarks_ByTask_Feeds_ContentItemsSource_TotalItemsCount.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.TotalItemsCount%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L153">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_TotalItemsCount_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.TotalItemsCount*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_TotalItemsCount" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.TotalItemsCount">TotalItemsCount</h4>
<div class="markdown level1 summary"><p>Returns the total number of generated items.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int TotalItemsCount { 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></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_Benchmarks_ByTask_Feeds_ContentItemsSource_AddBytes_System_Int64_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.AddBytes(System.Int64)%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L72">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_AddBytes_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.AddBytes*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_AddBytes_System_Int64_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.AddBytes(System.Int64)">AddBytes(Int64)</h4>
<div class="markdown level1 summary"><p>update count of bytes generated by this source</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void AddBytes(long numBytes)</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.Int64</span></td>
<td><span class="parametername">numBytes</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_Benchmarks_ByTask_Feeds_ContentItemsSource_AddItem.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.AddItem%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L82">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_AddItem_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.AddItem*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_AddItem" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.AddItem">AddItem()</h4>
<div class="markdown level1 summary"><p>update count of items generated by this source</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void AddItem()</code></pre>
</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_Benchmarks_ByTask_Feeds_ContentItemsSource_CollectFiles_System_IO_DirectoryInfo_System_Collections_Generic_IList_System_IO_FileInfo__.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.CollectFiles(System.IO.DirectoryInfo%2CSystem.Collections.Generic.IList%7BSystem.IO.FileInfo%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L96">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_CollectFiles_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.CollectFiles*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_CollectFiles_System_IO_DirectoryInfo_System_Collections_Generic_IList_System_IO_FileInfo__" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.CollectFiles(System.IO.DirectoryInfo,System.Collections.Generic.IList{System.IO.FileInfo})">CollectFiles(DirectoryInfo, IList&lt;FileInfo&gt;)</h4>
<div class="markdown level1 summary"><p>A convenience method for collecting all the files of a content source from
a given directory. The collected <span class="xref">System.IO.FileInfo</span> instances are stored in the
given <code data-dev-comment-type="paramref" class="paramref">files</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void CollectFiles(DirectoryInfo dir, IList&lt;FileInfo&gt; files)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.DirectoryInfo</span></td>
<td><span class="parametername">dir</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IList</span>&lt;<span class="xref">System.IO.FileInfo</span>&gt;</td>
<td><span class="parametername">files</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_Benchmarks_ByTask_Feeds_ContentItemsSource_Dispose.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Dispose%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L131">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_Dispose_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Dispose*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_Dispose" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Called when reading from this content source is no longer required.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</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_Benchmarks_ByTask_Feeds_ContentItemsSource_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Dispose(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L138">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_Dispose_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Dispose*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_Dispose_System_Boolean_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary"><p>Called when reading from this content source is no longer required.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected abstract void Dispose(bool disposing)</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.Boolean</span></td>
<td><span class="parametername">disposing</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_Benchmarks_ByTask_Feeds_ContentItemsSource_PrintStatistics_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.PrintStatistics(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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L191">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_PrintStatistics_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.PrintStatistics*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_PrintStatistics_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.PrintStatistics(System.String)">PrintStatistics(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void PrintStatistics(string itemsName)</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">itemsName</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_Benchmarks_ByTask_Feeds_ContentItemsSource_ResetInputs.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ResetInputs%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L163">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_ResetInputs_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ResetInputs*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_ResetInputs" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ResetInputs">ResetInputs()</h4>
<div class="markdown level1 summary"><p>Resets the input for this content source, so that the test would behave as
if it was just started, input-wise.
<p>
<strong>NOTE:</strong> the default implementation resets the number of bytes and
items generated since the last reset, so it&apos;s important to call
<code>base.ResetInputs()</code> in case you override this method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void ResetInputs()</code></pre>
</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_Benchmarks_ByTask_Feeds_ContentItemsSource_SetConfig_Lucene_Net_Benchmarks_ByTask_Utils_Config_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.SetConfig(Lucene.Net.Benchmarks.ByTask.Utils.Config)%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L174">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_SetConfig_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.SetConfig*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_SetConfig_Lucene_Net_Benchmarks_ByTask_Utils_Config_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.SetConfig(Lucene.Net.Benchmarks.ByTask.Utils.Config)">SetConfig(Config)</h4>
<div class="markdown level1 summary"><p>Sets the <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Utils.Config.html">Config</a> for this content source. If you override this
method, you must call <code>base.SetConfig(config)</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void SetConfig(Config config)</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.Benchmarks.ByTask.Utils.Config.html">Config</a></td>
<td><span class="parametername">config</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_Benchmarks_ByTask_Feeds_ContentItemsSource_ShouldLog.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ShouldLog%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L125">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_ShouldLog_" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ShouldLog*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource_ShouldLog" data-uid="Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource.ShouldLog">ShouldLog()</h4>
<div class="markdown level1 summary"><p>Returns <code>true</code> whether it&apos;s time to log a message (depending on verbose and
the number of items generated).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected bool ShouldLog()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Feeds_ContentItemsSource.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Feeds.ContentItemsSource%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.Benchmark/ByTask/Feeds/ContentItemsSource.cs/#L54" 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>