If failFast is true, then throw the first exception when index corruption is hit, instead of moving on to other fields/segments to look for any other corruption.

checkIterator

fun <T> checkIterator(iterator: MutableIterator<T?>)

fun <T> checkIterator(iterator: MutableIterator<T>, expectedSize: Long, allowNull: Boolean)

Checks that the provided iterator is well-formed.

checkReader

fun checkReader(reader: IndexReader)

This runs the CheckIndex tool on the Reader. If any issues are hit, a RuntimeException is thrown

fun checkReader(reader: LeafReader, level: Int)

checkReadOnly

fun <T> checkReadOnly(coll: MutableCollection<T?>)

Checks that the provided collection is read-only.

docs

fun docs(random: Random, termsEnum: TermsEnum, reuse: PostingsEnum?, flags: Int): PostingsEnum

fun docs(random: Random, r: IndexReader, field: String, term: BytesRef, reuse: PostingsEnum?, flags: Int): PostingsEnum?

doubleUlpEquals

fun doubleUlpEquals(x: Double, y: Double, maxUlps: Int): Boolean

Returns true if the arguments are equal or within the range of allowed error (inclusive). Returns false if either of the arguments is NaN.

fieldSupportsHugeBinaryDocValues

fun fieldSupportsHugeBinaryDocValues(field: String): Boolean

floatUlpEquals

fun floatUlpEquals(x: Float, y: Float, maxUlps: Short): Boolean

Returns true if the arguments are equal or within the range of allowed error (inclusive). Returns false if either of the arguments is NaN.

getDefaultCodec

fun getDefaultCodec(): Codec

Returns the actual default codec (e.g. LuceneMNCodec) for this version of Lucene. This may be different from Codec.getDefault because that is randomized.

getDefaultDocValuesFormat

fun getDefaultDocValuesFormat(): DocValuesFormat

Returns the actual default docvalues format (e.g. LuceneMNDocValuesFormat) for this version of Lucene.

getDefaultKnnVectorsFormat

fun getDefaultKnnVectorsFormat(): KnnVectorsFormat

Returns the actual default vector format (e.g. LuceneMNKnnVectorsFormat) for this version of Lucene.

getDefaultPostingsFormat

fun getDefaultPostingsFormat(): PostingsFormat

fun getDefaultPostingsFormat(minItemsPerBlock: Int, maxItemsPerBlock: Int): PostingsFormat

Returns the actual default postings format (e.g. LuceneMNPostingsFormat) for this version of Lucene.

getDocValuesFormat

fun getDocValuesFormat(field: String): String

fun getDocValuesFormat(codec: Codec, field: String): String

getPostingsFormat

fun getPostingsFormat(field: String): String

fun getPostingsFormat(codec: Codec, field: String): String

getPostingsFormatWithOrds

fun getPostingsFormatWithOrds(r: Random): PostingsFormat

Returns a random postings format that supports term ordinals

nextBigInteger

fun nextBigInteger(random: Random, maxBytes: Int): BigInteger

Returns a randomish big integer with 1 .. maxBytes storage.

nextInt

fun nextInt(r: Random, start: Int, end: Int): Int

start and end are BOTH inclusive

nextLong

fun nextLong(r: Random, start: Long, end: Long): Long

start and end are BOTH inclusive

ramCopyOf

fun ramCopyOf(dir: Directory): Directory

Returns a copy of the source directory, with file contents stored in RAM.

random

fun random(): Random

Returns a shared random instance for test code, similar to Lucene's random(). This is useful for test classes that want a consistent random source.

randomAnalysisString

fun randomAnalysisString(random: Random, maxLength: Int, simple: Boolean): String

Returns a valid (compiling) Pattern instance with random stuff inside. Be careful when applying random patterns to longer strings as certain types of patterns may explode into exponential times in backtracking implementations (such as Java's).

randomBinaryTerm

fun randomBinaryTerm(r: Random): BytesRef

Returns a random binary term.

fun randomBinaryTerm(r: Random, length: Int): BytesRef

Returns a random binary with a given length

randomFixedByteLengthUnicodeString

fun randomFixedByteLengthUnicodeString(r: Random, length: Int): String

Returns random string, with a given UTF-8 byte length

randomFixedLengthUnicodeString

fun randomFixedLengthUnicodeString(random: Random, chars: CharArray, offset: Int, length: Int)

Fills provided char[] with valid random unicode code unit sequence.

randomHtmlishString

fun randomHtmlishString(random: Random, numElements: Int): String

randomlyRecaseCodePoints

fun randomlyRecaseCodePoints(random: Random, str: String): String

Randomly upcases, downcases, or leaves intact each code point in the given string

randomRealisticUnicodeString

fun randomRealisticUnicodeString(r: Random): String

Returns random string of length between 0-20 codepoints, all codepoints within the same unicode block.

fun randomRealisticUnicodeString(r: Random, maxLength: Int): String

Returns random string of length up to maxLength codepoints , all codepoints within the same unicode block.

fun randomRealisticUnicodeString(r: Random, minLength: Int, maxLength: Int): String

Returns random string of length between min and max codepoints, all codepoints within the same unicode block.

randomRegexpishString

fun randomRegexpishString(r: Random): String

fun randomRegexpishString(r: Random, maxLength: Int): String

Returns a String that's "regexpish" (contains lots of operators typically found in regular expressions) If you call this enough times, you might get a valid regex!

randomSimpleString