// Path: src/main/java/net/amygdalum/stringsearchalgorithms/search/StringFinder.java
// public interface StringFinder {
// 
// 	/**
// 	 * @return the next match in the given document, the order of the matches is determined by the specific implementation
// 	 */
// 	StringMatch findNext();
// 	/**
// 	 * @return all matches in the given document, dependent on the specific implementation some matches may be skipped
// 	 */
// 	List<StringMatch> findAll();
// 	/**
// 	 * skips the document to a specific position (ignoring any match before this position)
// 	 * @param pos the new position to start with
// 	 */
// 	void skipTo(long pos);
// }
// 
// Path: src/main/java/net/amygdalum/stringsearchalgorithms/search/StringFinderOption.java
// public interface StringFinderOption {
// 
// }


import net.amygdalum.stringsearchalgorithms.search.StringFinder;
import net.amygdalum.stringsearchalgorithms.search.StringFinderOption;
import net.amygdalum.util.io.CharProvider;
package net.amygdalum.stringsearchalgorithms.search.chars;


/**
 * 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.
 */
public interface StringSearchAlgorithm {

	/**
	 * creates a StringFinder instance from the pattern (given by the current instance) and the given document.
	 * @param chars the given document wrapped into a CharProvider
	 * @param options the configuration options for the string finder
	 * @return a StringFinder that can iterate over the matches
	 */
	StringFinder createFinder(CharProvider chars, StringFinderOption... options);

	/**
	 * @return the length of the given pattern (min length in case of a multi string algorithm)
	 */
// Path: src/main/java/net/amygdalum/stringsearchalgorithms/search/StringFinder.java
// public interface StringFinder {
// 
// 	/**
// 	 * @return the next match in the given document, the order of the matches is determined by the specific implementation
// 	 */
// 	StringMatch findNext();
// 	/**
// 	 * @return all matches in the given document, dependent on the specific implementation some matches may be skipped
// 	 */
// 	List<StringMatch> findAll();
// 	/**
// 	 * skips the document to a specific position (ignoring any match before this position)
// 	 * @param pos the new position to start with
// 	 */
// 	void skipTo(long pos);
// }
// 
// Path: src/main/java/net/amygdalum/stringsearchalgorithms/search/StringFinderOption.java
// public interface StringFinderOption {
// 
// }


// Path: src/main/java/net/amygdalum/stringsearchalgorithms/search/chars/StringSearchAlgorithm.java
import net.amygdalum.stringsearchalgorithms.search.StringFinder;
import net.amygdalum.stringsearchalgorithms.search.StringFinderOption;
import net.amygdalum.util.io.CharProvider;

package net.amygdalum.stringsearchalgorithms.search.chars;


/**
 * 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.
 */
public interface StringSearchAlgorithm {

	/**
	 * creates a StringFinder instance from the pattern (given by the current instance) and the given document.
	 * @param chars the given document wrapped into a CharProvider
	 * @param options the configuration options for the string finder
	 * @return a StringFinder that can iterate over the matches
	 */
	StringFinder createFinder(CharProvider chars, StringFinderOption... options);

	/**
	 * @return the length of the given pattern (min length in case of a multi string algorithm)
	 */
	int getPatternLength();