com.steelypip.powerups.charrepeater

Interface CharRepeater

All Known Implementing Classes:

ReaderCharRepeater

public interface CharRepeater

This is an interface for a char based stream that supports unlimited pushback. With Java 8 streams this might be a bit superfluous - I haven't quite got the full sense of what Streams are meant to be.

Method Summary

Modifier and Type	Method and Description
boolean	hasNextChar() Returns true if it there are characters available to be consumed from the input, otherwise false.
boolean	isNextChar(char wanted) Returns true if it the next character is the same as wanted, otherwise false.
boolean	isNextString(java.lang.String wanted) Returns true if it the next sequence of characters matches the string wanted, otherwise false.
char	nextChar() Returns the next character from the input, consuming it from the input.
char	nextChar(char value_if_needed) Returns the next character from the input, consuming it from the input.
char	peekChar() Returns the next character from the input, but does not consume it.
char	peekChar(char value_if_needed) Returns the next character from the input, but does not consume it.
void	pushChar(char value) Pushes a character onto the front of the input.
void	skipChar() Discards the next character from the input.

Method Detail

hasNextChar

boolean hasNextChar()

Returns true if it there are characters available to be consumed from the input, otherwise false.

Returns:

true if there are more characters, else false

isNextChar

boolean isNextChar(char wanted)

Returns true if it the next character is the same as wanted, otherwise false. If the input is exhausted then this method returns false.

Parameters:

wanted - the character that we are looking for

Returns:

the next character is equal to wanted

isNextString

boolean isNextString(java.lang.String wanted)

Returns true if it the next sequence of characters matches the string wanted, otherwise false. If the input is exhausted then this method returns false.

Parameters:

wanted - the sequence of characters that we are looking for

Returns:

if true then the wanted string is waiting to be read

nextChar

char nextChar()

Returns the next character from the input, consuming it from the input. If there are no characters waiting to be read an exception is thrown.

Returns:

the next character.

nextChar

char nextChar(char value_if_needed)

Returns the next character from the input, consuming it from the input. If there are no characters waiting to be read the default value_if_neeeded is returned.

Parameters:

value_if_needed - default returned if the input is exhausted.

Returns:

the next character from the input

pushChar

void pushChar(char value)

Pushes a character onto the front of the input. It does not have to be the same as the previous character that was read from the input. There is no hard limit to how many characters are pushed.

Parameters:

value - the character to be pushed back

peekChar

char peekChar()

Returns the next character from the input, but does not consume it. If there are no characters waiting to be read an exception is thrown.

Returns:

the next character from the input

peekChar

char peekChar(char value_if_needed)

Returns the next character from the input, but does not consume it. If there are no characters waiting to be read the default value_if_neeeded is returned.

Parameters:

value_if_needed - default returned if the input is exhausted.

Returns:

the next character from the input

skipChar

void skipChar()

Discards the next character from the input. If the input is exhausted then this method has no effect.