net.amygdalum.stringsearchalgorithms.search.bytes

Interface StringSearchAlgorithm

All Known Implementing Classes:

AhoCorasick, BNDM, BOM, Horspool, KnuthMorrisPratt, SetBackwardOracleMatching, SetHorspool, ShiftAnd, ShiftOr, Sunday, WuManber

public interface StringSearchAlgorithm

a generic interface for string search algorithms (both single- and multi-string-algorithms implement this) classes implementing this interface should incorporate the pattern to search.

Method Summary

Modifier and Type	Method and Description
StringFinder	createFinder(ByteProvider bytes, StringFinderOption... options) creates a StringFinder instance from the pattern (given by the current instance) and the given document.
int	getPatternLength()

Method Detail

createFinder

StringFinder createFinder(ByteProvider bytes,
                          StringFinderOption... options)

creates a StringFinder instance from the pattern (given by the current instance) and the given document.

Parameters:

bytes - the given document wrapped into a ByteProvider

options - the configuration options for the string finder

Returns:

a StringFinder that can iterate over the matches

getPatternLength

int getPatternLength()

Returns:

the length of the given pattern (min length in case of a multi string algorithm)