blob: 7582ddc79b7a51e6b3c34598e6b3758cf02224b6 [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>Namespace Lucene.Net.Util
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Util
| 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.Util">
<h1 id="Lucene_Net_Util" data-uid="Lucene.Net.Util" class="text-break">Namespace Lucene.Net.Util
</h1>
<div class="markdown level0 summary"><!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<p>General test support. The primary class is <a class="xref" href="Lucene.Net.Util.LuceneTestCase.html">LuceneTestCase</a>,
which extends JUnit with additional functionality.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.Util.BaseDocIdSetTestCase-1.html">BaseDocIdSetTestCase&lt;T&gt;</a></h4>
<section><p>Base test class for <a class="xref" href="../Lucene.Net/Lucene.Net.Search.DocIdSet.html">DocIdSet</a>s. </p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.English.html">English</a></h4>
<section><p>Converts numbers to english strings for testing.
<p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Util.FailOnNonBulkMergesInfoStream.html">FailOnNonBulkMergesInfoStream</a></h4>
<section><p>Hackidy-Häck-Hack to cause a test to fail on non-bulk merges </p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.LineFileDocs.html">LineFileDocs</a></h4>
<section><p>Minimal port of benchmark&apos;s LneDocSource +
DocMaker, so tests can enum docs from a line file created
by benchmark&apos;s WriteLineDoc task</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.LuceneTestCase.html">LuceneTestCase</a></h4>
<section><p>LUCENENET specific extensions to <a class="xref" href="Lucene.Net.Util.LuceneTestCase.html">LuceneTestCase</a> to make it easier to port tests
from Java with fewer changes.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.LuceneTestCase.ConcurrentMergeSchedulerFactories.html">LuceneTestCase.ConcurrentMergeSchedulerFactories</a></h4>
<section><p>Contains a list of all the Func&lt;IConcurrentMergeSchedulers&gt; to be tested.
Delegate method allows them to be created on their target thread instead of the test thread
and also ensures a separate instance is created in each case (which can affect the result of the test).
<p>
LUCENENET specific for injection into tests (i.e. using NUnit.Framework.ValueSourceAttribute)</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.LuceneTestCase.SuppressCodecsAttribute.html">LuceneTestCase.SuppressCodecsAttribute</a></h4>
<section><p>Annotation for test classes that should avoid certain codec types
(because they are expensive, for example).</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.LuceneTestCase.SuppressTempFileChecksAttribute.html">LuceneTestCase.SuppressTempFileChecksAttribute</a></h4>
<section><p>Marks any suites which are known not to close all the temporary
files. This may prevent temp files and folders from being cleaned
up after the suite is completed.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.NullInfoStream.html">NullInfoStream</a></h4>
<section><p>Prints nothing. Just to make sure tests pass w/ and without enabled <a class="xref" href="../Lucene.Net/Lucene.Net.Util.InfoStream.html">InfoStream</a>
without actually making noise.
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Util.StackTraceHelper.html">StackTraceHelper</a></h4>
<section><p>LUCENENET specific class to normalize stack trace behavior between different .NET Framework and .NET Standard 1.x,
which did not support the StackTrace class.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.TestUtil.html">TestUtil</a></h4>
<section><p>General utility methods for Lucene unit tests.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.ThrottledIndexOutput.html">ThrottledIndexOutput</a></h4>
<section><p>Intentionally slow <a class="xref" href="../Lucene.Net/Lucene.Net.Store.IndexOutput.html">IndexOutput</a> for testing.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Util.TimeUnits.html">TimeUnits</a></h4>
<section><p>Time unit constants for use in annotations. </p>
</section>
</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/blob/docs-4.8.0-beta00007/src/Lucene.Net.TestFramework/Util/package.md/#L2" class="contribution-link">Improve this Doc</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>