net.amygdalum.stringsearchalgorithms.io

Interface CharProvider

All Known Implementing Classes:

CaseInsensitiveCharProvider, ComparingCharProvider, MappingCharProvider, ReaderBufferCharProvider, ReaderCharProvider, ReverseCharProvider, StringCharProvider

public interface CharProvider

Method Summary

Modifier and Type	Method and Description
char	at(long i)
char[]	between(long start, long end) This method returns the chars between the given absolute positions.
boolean	changed()
long	current() This method returns the current positions.
void	finish()
boolean	finished()
boolean	finished(int i)
void	forward(int i)
char	lookahead()
char	lookahead(int i)
char	lookbehind()
char	lookbehind(int i)
void	mark()
void	move(long i) This method moves to the given absolute position.
char	next()
char	prev()
String	slice(long start, long end) This method returns the original String between the given absolute positions.

Method Detail

next

char next()

lookahead

char lookahead()

lookahead

char lookahead(int i)

prev

char prev()

lookbehind

char lookbehind()

lookbehind

char lookbehind(int i)

current

long current()

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).

Returns:

the current position

move

void move(long i)

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.

Parameters:

i - the position to move

See Also:

current()

between

char[] between(long start,
               long end)

This method returns the chars between the given absolute positions. The arguments of between(long,long) must be consistent with current().

Parameters:

start - the first position

end - the last position (exclusive)

Returns:

the chars between start and end

Throws:

NegativeArraySizeException - if start is after end (which is not necessarily start < end)

See Also:

current()

slice

String slice(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 chars of between(long,long).

Parameters:

start - the first position

end - the last position (exclusive)

Returns:

the String between start and end (in the original source)

Throws:

NegativeArraySizeException - if start is after end (which is not necessarily start < end)

forward

void forward(int i)

finish

void finish()

finished

boolean finished()

finished

boolean finished(int i)

at

char at(long i)

mark

void mark()

changed

boolean changed()