me.jamiemansfield.string

Class StringReader

java.lang.Object

me.jamiemansfield.string.StringReader

public class StringReader
extends Object

Reader for strings.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
StringReader(String source)

Method Summary

Modifier and Type	Method and Description
char	advance() Gets the character at the current index, and increments the index.
char	advance(int offset) Gets the character at the current index and offset, and increments the index by the offset.
boolean	available() Establishes whether there is a character to immediately read.
int	index() Gets the index of the character currently being read.
int	length() Gets the length of the source.
char	peek() Gets the character at the current index.
char	peek(int offset) Gets the character at the current index and offset.
boolean	readable(int offset) Establishes whether there is a character to read, with the given offset.
int	remaining() Gets the count of the remaining characters to be read.
void	skip(int length) Advances the index by the given length.
String	substring(int start, int end) Gets a substring of the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringReader

public StringReader(String source)

Method Detail

length

public int length()

Gets the length of the source.

Returns:

The source length

remaining

public int remaining()

Gets the count of the remaining characters to be read.

Returns:

The remaining character count

index

public int index()

Gets the index of the character currently being read.

Returns:

The current index

readable

public boolean readable(int offset)

Establishes whether there is a character to read, with the given offset.

Parameters:

offset - How many characters ahead

Returns:

true if there is a character to read; false otherwise

available

public boolean available()

Establishes whether there is a character to immediately read.

Returns:

true if there is a character to be read; false otherwise

skip

public void skip(int length)

Advances the index by the given length.

Parameters:

length - How much to advance by

peek

public char peek()

Gets the character at the current index.

Returns:

The current character

peek

public char peek(int offset)

Gets the character at the current index and offset.

Parameters:

offset - The offset of the character

Returns:

The character

advance

public char advance()

Gets the character at the current index, and increments the index.

Returns:

The current character

advance

public char advance(int offset)

Gets the character at the current index and offset, and increments the index by the offset.

Parameters:

offset - The offset of the character

Returns:

The character

substring

public String substring(int start,
                        int end)

Gets a substring of the source.

Parameters:

start - The start index

end - The end index

Returns:

The substring'd result

See Also:

String.substring(int, int)