de.weltraumschaf.commons.characters

Class CharacterStream

java.lang.Object

de.weltraumschaf.commons.characters.CharacterStream

public class CharacterStream
extends Object

Access a string as stream of characters.

Example:

 final CharacterStream characterStream = new CharacterStream("...");

 while (characterStream.hasNext()) {
     final char currentChar = characterStream.next();
     // Do something with the current char.
 }
 

TODO: Implement line and column.

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
private int	index Current character position.
private String	input Accessed string.

Constructor Summary

Constructors

Constructor and Description
CharacterStream(String input) Initializes stream with string.

Method Summary

Methods

Modifier and Type	Method and Description
char	current() Returns the current character.
int	getIndex() Get the current index position.
boolean	hasNext() True if there are more characters.
char	next() Returns next character.
char	peek() Look ahead one character w/o advancing the internal pointer for the current character.

Methods inherited from class java.lang.Object

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

Field Detail

input

private final String input

Accessed string.

index

private int index

Current character position.

Constructor Detail

CharacterStream

public CharacterStream(String input)

Initializes stream with string.

Parameters:

input - Streamed string.

Method Detail

next

public char next()

Returns next character.

Returns:

next character // CHECKSTYLE:OFF

Throws:

IndexOutOfBoundsException - if, there are no more characters. // CHECKSTYLE:ON

hasNext

public boolean hasNext()

True if there are more characters.

Returns:

True if there are no more characters.

current

public char current()

Returns the current character. If next() not yet called, it is called implicitly.

Returns:

The current character.

peek

public char peek()

Look ahead one character w/o advancing the internal pointer for the current character.

Returns:

the peeked character. // CHECKSTYLE:OFF

Throws:

IndexOutOfBoundsException - if there are no more character to peek // CHECKSTYLE:ON

getIndex

public int getIndex()

Get the current index position.

Returns:

initial value is -1, after first call of next 0 up to input length - 1