revxrsal.commands.stream

Interface MutableStringStream

All Superinterfaces:

StringStream

All Known Implementing Classes:

MutableStringStreamImpl

public interface MutableStringStream
extends StringStream

An interface that aids in parsing a stream of characters.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	consumeRemaining() Consumes the rest of the stream
void	moveBackward() Moves the cursor 1 step backward
void	moveBackward(int by) Moves the cursor by the given steps backward
void	moveForward() Moves the cursor 1 step forward
void	moveForward(int by) Moves the cursor by the given steps forward
char	read() Reads the next character, and moves the cursor forward.
java.lang.String	read(int characters) Reads the given number of characters, and moves the cursor forward.
boolean	readBoolean() Parses the next token as a boolean.
byte	readByte() Parses the next token as a byte.
double	readDouble() Parses the next token as a double.
float	readFloat() Parses the next token as a float.
int	readInt() Parses the next token as an int.
long	readLong() Parses the next token as a long.
short	readShort() Parses the next token as a short.
@NotNull java.lang.String	readString() Reads the next string.
@NotNull java.lang.String	readUnquotedString() Reads a single, unquoted string.
@NotNull java.lang.String	readUntil(char delimiter) Reads a string until it encounters the given delimiter character.
@NotNull java.lang.String	readWhile(CharPredicate predicate) Reads from the text stream until the given predicate returns false.
void	setPosition(int position) Sets the current position of the cursor
void	skipToEnd() Skips to the end of the stream
void	skipWhitespace() Skips all the upcoming whitespace
@NotNull @Unmodifiable StringStream	toImmutableCopy() Returns an StringStream copy of this string stream
@NotNull MutableStringStream	toMutableCopy() Returns a new, mutable MutableStringStream copy of this stream.

Methods inherited from interface revxrsal.commands.stream.StringStream

canRead, create, create, createMutable, createMutable, hasFinished, hasRemaining, isEmpty, isMutable, peek, peek, peekOffset, peekRemaining, peekString, peekUnquotedString, position, remaining, source, totalSize

Method Detail

read

char read()

Reads the next character, and moves the cursor forward.

Returns:

The next character

read

java.lang.String read(int characters)

Reads the given number of characters, and moves the cursor forward.

Returns:

The number of characters to read

moveForward

void moveForward()

Moves the cursor 1 step forward

skipWhitespace

void skipWhitespace()

Skips all the upcoming whitespace

moveBackward

void moveBackward()

Moves the cursor 1 step backward

moveForward

void moveForward(int by)

Moves the cursor by the given steps forward

Parameters:

by - Steps to move

moveBackward

void moveBackward(int by)

Moves the cursor by the given steps backward

Parameters:

by - Steps to move

consumeRemaining

@NotNull
@NotNull java.lang.String consumeRemaining()

Consumes the rest of the stream

Returns:

The remaining string

skipToEnd

void skipToEnd()

Skips to the end of the stream

readUnquotedString

@NotNull
@NotNull java.lang.String readUnquotedString()

Reads a single, unquoted string. This will simply move forward until it encounters a whitespace character.

Returns:

The next string

readString

@NotNull
@NotNull java.lang.String readString()

Reads the next string. If the string was quoted, it will read the entire string inside the quotes. Otherwise, it will consume the next string until a whitespace character is encountered.

Returns:

The next string.

readUntil

@NotNull
@NotNull java.lang.String readUntil(char delimiter)

Reads a string until it encounters the given delimiter character. This method will respect escaping backslashes that come before a delimiter or before another backslash.

Parameters:

delimiter - Delimiter character

Returns:

The read string

readWhile

@NotNull
@NotNull java.lang.String readWhile(CharPredicate predicate)

Reads from the text stream until the given predicate returns false.

Parameters:

predicate - Predicate to test with

Returns:

The read string.

readFloat

float readFloat()

Parses the next token as a float.

Returns:

The next token, as a float.

readDouble

double readDouble()

Parses the next token as a double.

Returns:

The next token, as a double.

readInt

int readInt()

Parses the next token as an int.

Returns:

The next token, as an int.

readLong

long readLong()

Parses the next token as a long.

Returns:

The next token, as a long.

readShort

short readShort()

Parses the next token as a short.

Returns:

The next token, as a short.

readByte

byte readByte()

Parses the next token as a byte.

Returns:

The next token, as a byte.

readBoolean

boolean readBoolean()

Parses the next token as a boolean.

Returns:

The next token, as a boolean.

setPosition

void setPosition(int position)

Sets the current position of the cursor

Parameters:

position - The cursor position

toImmutableCopy

@NotNull
 @Contract(pure=true,
          value="-> new")
@NotNull @Unmodifiable StringStream toImmutableCopy()

Returns an StringStream copy of this string stream

Specified by:

toImmutableCopy in interface StringStream

Returns:

an immutable copy of this.

toMutableCopy

@NotNull
 @Contract(pure=true,
          value="-> new")
@NotNull MutableStringStream toMutableCopy()

Returns a new, mutable MutableStringStream copy of this stream.

Specified by:

toMutableCopy in interface StringStream

Returns:

The new string stream