net.amygdalum.stringsearchalgorithms.io

Class MappingCharProvider

java.lang.Object

net.amygdalum.stringsearchalgorithms.io.MappingCharProvider

All Implemented Interfaces:

CharProvider

Direct Known Subclasses:

CaseInsensitiveCharProvider

public abstract class MappingCharProvider
extends Object
implements CharProvider

Constructor Summary

Constructors

Constructor and Description
MappingCharProvider(CharProvider chars)

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)
protected abstract char	map(char base)
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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MappingCharProvider

public MappingCharProvider(CharProvider chars)

Method Detail

map

protected abstract char map(char base)

next

public char next()

Specified by:

next in interface CharProvider

lookahead

public char lookahead()

Specified by:

lookahead in interface CharProvider

lookahead

public char lookahead(int i)

Specified by:

lookahead in interface CharProvider

prev

public char prev()

Specified by:

prev in interface CharProvider

lookbehind

public char lookbehind()

Specified by:

lookbehind in interface CharProvider

lookbehind

public char lookbehind(int i)

Specified by:

lookbehind in interface CharProvider

current

public long current()

Description copied from interface: CharProvider

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

Specified by:

current in interface CharProvider

Returns:

the current position

move

public void move(long i)

Description copied from interface: CharProvider

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.

Specified by:

move in interface CharProvider

Parameters:

i - the position to move

See Also:

CharProvider.current()

between

public char[] between(long start,
                      long end)

Description copied from interface: CharProvider

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

Specified by:

between in interface CharProvider

Parameters:

start - the first position

end - the last position (exclusive)

Returns:

the chars between start and end

See Also:

CharProvider.current()

slice

public String slice(long start,
                    long end)

Description copied from interface: CharProvider

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

Specified by:

slice in interface CharProvider

Parameters:

start - the first position

end - the last position (exclusive)

Returns:

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

forward

public void forward(int i)

Specified by:

forward in interface CharProvider

finish

public void finish()

Specified by:

finish in interface CharProvider

finished

public boolean finished()

Specified by:

finished in interface CharProvider

finished

public boolean finished(int i)

Specified by:

finished in interface CharProvider

at

public char at(long i)

Specified by:

at in interface CharProvider

mark

public void mark()

Specified by:

mark in interface CharProvider

changed

public boolean changed()

Specified by:

changed in interface CharProvider

toString

public String toString()

Overrides:

toString in class Object