net.lenni0451.commons.strings

Class StringReader

java.lang.Object

net.lenni0451.commons.strings.StringReader

public class StringReader
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StringReader(java.lang.String s)

Method Summary

Modifier and Type	Method and Description
int	getIndex()
boolean	hasNext()
char	next() Read the next character and increase the index by 1.
char	peek() Peek the next character without increasing the index.
java.lang.String	peek(int amount) Peek the next characters without increasing the index.
java.lang.String	peekRemaining() Peek the remaining characters without increasing the index.
java.lang.String	readQuoted() Read the next quoted string and skip all upcoming whitespace characters.
java.lang.String	readUntil(char c) Read all characters until the given character is found.
java.lang.String	readWord() Read the next word (characters until the next whitespace character) and skip all upcoming whitespace characters.
void	setIndex(int index) Set the index of the reader.
StringReader	skip() Skip the next character and increase the index by 1.
StringReader	skip(int amount) Skip the next characters and increase the index by the given amount.
StringReader	skipUntil(char c) Skip all characters until the given character is found.
StringReader	skipWhitespace() Skip all upcoming whitespace characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringReader

public StringReader(java.lang.String s)

Method Detail

getIndex

public int getIndex()

Returns:

The current index of the reader

setIndex

public void setIndex(int index)

Set the index of the reader.

Parameters:

index - The new index

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds

hasNext

public boolean hasNext()

Returns:

If there are more characters to read

next

public char next()

Read the next character and increase the index by 1.

Returns:

The next character

Throws:

java.lang.IndexOutOfBoundsException - If there are no more characters to read

peek

public char peek()

Peek the next character without increasing the index.

Returns:

The next character

Throws:

java.lang.IndexOutOfBoundsException - If there are no more characters to peek

peek

public java.lang.String peek(int amount)

Peek the next characters without increasing the index.

Parameters:

amount - The amount of characters to peek

Returns:

The next characters

Throws:

java.lang.IndexOutOfBoundsException - If there are not enough characters to peek

peekRemaining

public java.lang.String peekRemaining()

Peek the remaining characters without increasing the index.

Returns:

The remaining characters

skip

public StringReader skip()

Skip the next character and increase the index by 1.

Returns:

The reader itself

Throws:

java.lang.IndexOutOfBoundsException - If there are no more characters to skip

skip

public StringReader skip(int amount)

Skip the next characters and increase the index by the given amount.

Parameters:

amount - The amount of characters to skip

Returns:

The reader itself

Throws:

java.lang.IndexOutOfBoundsException - If there are not enough characters to skip

skipWhitespace

public StringReader skipWhitespace()

Skip all upcoming whitespace characters.

Returns:

The reader itself

skipUntil

public StringReader skipUntil(char c)

Skip all characters until the given character is found.
The character itself will not be skipped.

Parameters:

c - The character to skip until

Returns:

The reader itself

readUntil

public java.lang.String readUntil(char c)

Read all characters until the given character is found.
The character itself will not be read.

Parameters:

c - The character to read until

Returns:

The read characters

readWord

public java.lang.String readWord()

Read the next word (characters until the next whitespace character) and skip all upcoming whitespace characters.

Returns:

The read word

Throws:

java.lang.IllegalStateException - If there are no more characters to read

readQuoted

public java.lang.String readQuoted()

Read the next quoted string and skip all upcoming whitespace characters.
Quotes are " and '.

Returns:

The read quoted string

Throws:

java.lang.IllegalStateException - If the next character is not a quote character