net.amygdalum.stringsearchalgorithms.search

Interface StringFinder

All Known Implementing Classes:

AbstractStringFinder, BufferedStringFinder, EmptyMatchFinder

public interface StringFinder

an interface for generic string search. StringFinders are generated from a StringSearchAlgorithm together with a Char/ByteProvider (which is the document to search in).

Method Summary

Modifier and Type	Method and Description
List<StringMatch>	findAll()
StringMatch	findNext()
void	skipTo(long pos) skips the document to a specific position (ignoring any match before this position)

Method Detail

findNext

StringMatch findNext()

Returns:

the next match in the given document, the order of the matches is determined by the specific implementation

findAll

List<StringMatch> findAll()

Returns:

all matches in the given document, dependent on the specific implementation some matches may be skipped

skipTo

void skipTo(long pos)

skips the document to a specific position (ignoring any match before this position)

Parameters:

pos - the new position to start with