com.steelypip.powerups.charrepeater

Class ReaderCharRepeater

java.lang.Object

com.steelypip.powerups.charrepeater.ReaderCharRepeater

All Implemented Interfaces:

CharRepeater

public class ReaderCharRepeater
extends java.lang.Object
implements CharRepeater

This class is used to convert a java.lang.Reader into character repeater that supports arbitrary pushback.

Constructor Summary

Constructors

Constructor and Description
ReaderCharRepeater(java.io.Reader reader) Constructs the character repeater from a java.lang.Reader

Method Summary

Modifier and Type	Method and Description
boolean	hasNextChar() This is the key method used to take characters off the input stream.
boolean	isNextChar(char wanted) Checks whether or not the next character is the same as wanted.
boolean	isNextString(java.lang.String wanted) Checks whether or not the sequence of characters in the string wanted is waiting to be read off the input.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderCharRepeater

public ReaderCharRepeater(java.io.Reader reader)

Constructs the character repeater from a java.lang.Reader

Parameters:

reader - the input stream

Method Detail

hasNextChar

public boolean hasNextChar()

This is the key method used to take characters off the input stream. If the method returns true then it is guaranteed that there is at least one character in the buffer.

Specified by:

hasNextChar in interface CharRepeater

Returns:

true if there are more characters, else false

isNextChar

public boolean isNextChar(char wanted)

Checks whether or not the next character is the same as wanted. If there's no next character it returns false. It does not consume any characters.

Specified by:

isNextChar in interface CharRepeater

Parameters:

wanted - the character that we are looking for

Returns:

the next character is equal to wanted

isNextString

public boolean isNextString(java.lang.String wanted)

Checks whether or not the sequence of characters in the string wanted is waiting to be read off the input. This is the same as calling isNextString( wanted, 0 ).

Specified by:

isNextString in interface CharRepeater

Parameters:

wanted - The sequence of characters that we are looking for.

Returns:

True if the input matches wanted.

nextChar

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

Specified by:

nextChar in interface CharRepeater

Returns:

the next character.

nextChar

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

Specified by:

nextChar in interface CharRepeater

Parameters:

value_if_needed - default returned if the input is exhausted.

Returns:

the next character from the input

pushChar

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

Specified by:

pushChar in interface CharRepeater

Parameters:

value - the character to be pushed back

peekChar

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

Specified by:

peekChar in interface CharRepeater

Returns:

the next character from the input

peekChar

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

Specified by:

peekChar in interface CharRepeater

Parameters:

value_if_needed - default returned if the input is exhausted.

Returns:

the next character from the input

skipChar

public void skipChar()

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

Specified by:

skipChar in interface CharRepeater