net.sourceforge.chessshell.plugin.api

Interface ICharGetter

public interface ICharGetter

It offers the ability to get one character at a time from an input source.

Method Summary

Modifier and Type	Method and Description
void	backOne() Jump one character back in the input stream.
void	close() Finish any pending work, cleanup ressources.
long	getBytePosition()
char	getChar()
java.lang.String	getEncoding()
int	getLineNo()
int	getPositionInLine()
java.lang.String	getString(long from, long to)
void	ignoreRestOfCurrentLine()
void	init() init is useful between calls to getString()
boolean	isAtEnd()

Method Detail

getChar

char getChar()

isAtEnd

boolean isAtEnd()

backOne

void backOne()

Jump one character back in the input stream. You cannot call it two times without any intervening calls to getChar() - it won't work.

close

void close()

Finish any pending work, cleanup ressources.

getBytePosition

long getBytePosition()

getString

java.lang.String getString(long from,
                           long to)

init

void init()

init is useful between calls to getString()

getPositionInLine

int getPositionInLine()

ignoreRestOfCurrentLine

void ignoreRestOfCurrentLine()

getEncoding

java.lang.String getEncoding()

getLineNo

int getLineNo()