net.amygdalum.stringsearchalgorithms.io.ByteProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stringsearchalgorithms Show documentation

Searching and Matching Strings with efficient algorithms: - Knuth-Morris-Pratt - Shift-And/Or - Boyer-Moore-Horspool - Sunday (QuickSearch) - BNDM - BOM - Aho-Corasick - Set-Horspool - Wu-Manber - Set-BOM

There is a newer version: 0.4.4

Show newest version

package net.amygdalum.stringsearchalgorithms.io;

import net.amygdalum.util.text.ByteString;

public interface ByteProvider {

	byte next();
	byte lookahead();
	byte lookahead(int i);
	byte prev();
	byte lookbehind();
	byte lookbehind(int i);

	/**
	 * This method returns the current positions. 
	 * 
	 * The result of current() must be consistent with move(int),between(int,int) and slice(int,int), e.g. move(current()) must not change the state.
	 * 
	 * There are no consistency constrains to other methods, especially one should NOT assume that moving with next/prev/forward changes current in a defined way (NOT +1/-1/+n).
	 * 
	 * @return the current position
	 */
	long current();
	
	/**
	 * This method moves to the given absolute position.
	 * 
	 * The argument of move(long) must be consistent with current(). That means move(current()) must not change the state.
	 * 
	 * @param i the position to move
	 * @see #current()   
	 */
	void move(long i);
	
	/**
	 * This method returns the chars between the given absolute positions.
	 * 
	 * The arguments of between(long,long) must be consistent with current(). 
	 * 
	 * @throws NegativeArraySizeException if start is after end (which is not necessarily start < end)
	 * @param start the first position
	 * @param end the last position (exclusive)
	 * @return the chars between start and end
	 * @see #current()   
	 */
	byte[] between(long start, long end);

	/**
	 * This method returns the original String between the given absolute positions.
	 * 
	 * Note that the original String might differ from the provided bytes of between(long,long). 
	 * 
	 * @throws NegativeArraySizeException if start is after end (which is not necessarily start < end)
	 * @param start the first position
	 * @param end the last position (exclusive)
	 * @return the String between start and end (in the original source)
	 */
	ByteString slice(long start, long end);

	void forward(int i);
	void finish();
	boolean finished();
	boolean finished(int i);

	byte at(long i);

	void mark();
	boolean changed();

}