SearchCursor

class SearchCursor(text: Text, query: String, from: DocPos = DocPos.ZERO, to: DocPos = text.endPos, normalize: (String) -> String = { it }) : Iterator<SearchMatch>

A cursor that iterates over string matches in a Text document.

text

The document text to search through.

query

The string to search for.

from

Start position of the search range (inclusive).

End position of the search range (exclusive, defaults to document length).

normalize

Optional normalization function (e.g. String.lowercase for case-insensitive).

Constructors

constructor(text: Text, query: String, from: DocPos = DocPos.ZERO, to: DocPos = text.endPos, normalize: (String) -> String = { it })

Whether the cursor has been exhausted.

The current match, or null if iteration hasn't started or is done.

open operator override fun hasNext(): Boolean

open operator override fun next(): SearchMatch

Return the next match, or null if there are no more matches.