revxrsal.commands.stream

Interface StringStream

All Known Subinterfaces:

MutableStringStream

All Known Implementing Classes:

MutableStringStreamImpl

public interface StringStream

Method Summary

Modifier and Type	Method and Description
boolean	canRead(int characters) Tests whether the stream can read the given characters count
static @NotNull StringStream	create(@NotNull java.lang.String source) Returns an immutable StringStream with the given source, starting at the beginning of the string.
static @NotNull StringStream	create(@NotNull java.lang.String source, int position) Returns an immutable StringStream with the given source and cursor position
static @NotNull MutableStringStream	createMutable(@NotNull java.lang.String source) Returns a mutable MutableStringStream with the given source, starting at the beginning of the string.
static @NotNull MutableStringStream	createMutable(@NotNull java.lang.String source, int position) Returns a mutable MutableStringStream with the given source and cursor position
boolean	hasFinished() Tests whether this stream has finished parsing or not
boolean	hasRemaining() Tests whether there are any characters left in the string stream
boolean	isEmpty() Tests whether is this stream empty or not.
boolean	isMutable() Tests whether is this stream mutable or not
char	peek() Peeks the next character, without moving the cursor forward.
java.lang.String	peek(int characters) Peeks the next number of character, without moving the cursor forward.
char	peekOffset(int offset) Peeks the character after offset chars, without moving the cursor forward.
@NotNull java.lang.String	peekRemaining() Peeks the remainder of the string stream
@NotNull java.lang.String	peekString() Peeks the next string.
@NotNull java.lang.String	peekUnquotedString() Peeks a single, unquoted string.
int	position() Returns the cursor position
int	remaining() Returns the characters remaining
@NotNull java.lang.String	source() Returns the original entire string source.
@NotNull @Unmodifiable StringStream	toImmutableCopy() Returns an StringStream copy of this string stream
@NotNull MutableStringStream	toMutableCopy() Returns a new, mutable MutableStringStream copy of this stream.
int	totalSize() Returns the size of the source

Method Detail

create

@NotNull
static @NotNull StringStream create(@NotNull
                                             @NotNull java.lang.String source,
                                             int position)

Returns an immutable StringStream with the given source and cursor position

Parameters:

source - The source string to work with

position - The cursor position

Returns:

The newly created StringStream

create

@NotNull
static @NotNull StringStream create(@NotNull
                                             @NotNull java.lang.String source)

Returns an immutable StringStream with the given source, starting at the beginning of the string.

Parameters:

source - The source string to work with

Returns:

The newly created StringStream

createMutable

@NotNull
static @NotNull MutableStringStream createMutable(@NotNull
                                                           @NotNull java.lang.String source,
                                                           int position)

Returns a mutable MutableStringStream with the given source and cursor position

Parameters:

source - The source string to work with

position - The cursor position

Returns:

The newly created MutableStringStream

createMutable

@NotNull
static @NotNull MutableStringStream createMutable(@NotNull
                                                           @NotNull java.lang.String source)

Returns a mutable MutableStringStream with the given source, starting at the beginning of the string.

Parameters:

source - The source string to work with

Returns:

The newly created MutableStringStream

source

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

Returns the original entire string source.

Returns:

The string source

totalSize

int totalSize()

Returns the size of the source

Returns:

The source size

remaining

int remaining()

Returns the characters remaining

Returns:

The number of characters remaining

peek

char peek()

Peeks the next character, without moving the cursor forward.

Returns:

The next character

peek

java.lang.String peek(int characters)

Peeks the next number of character, without moving the cursor forward.

Returns:

The number of characters to peek

peekOffset

char peekOffset(int offset)

Peeks the character after offset chars, without moving the cursor forward.

Parameters:

offset - Characters to peek

Returns:

The next character

hasRemaining

boolean hasRemaining()

Tests whether there are any characters left in the string stream

Returns:

if there are any characters left

hasFinished

boolean hasFinished()

Tests whether this stream has finished parsing or not

Returns:

If the stream has finished or not

canRead

boolean canRead(int characters)

Tests whether the stream can read the given characters count

Parameters:

characters - Number of characters

Returns:

if such a number can be read or not.

position

int position()

Returns the cursor position

Returns:

The cursor position

peekUnquotedString

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

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

This will not move the cursor forward.

Returns:

The peeked string

peekString

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

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

This will not move the cursor forward.

Returns:

The next string.

peekRemaining

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

Peeks the remainder of the string stream

Returns:

The peeked string

toImmutableCopy

@NotNull
@NotNull @Unmodifiable StringStream toImmutableCopy()

Returns an StringStream copy of this string stream

Returns:

an immutable copy of this.

toMutableCopy

@NotNull
@NotNull MutableStringStream toMutableCopy()

Returns a new, mutable MutableStringStream copy of this stream.

Returns:

The new string stream

isMutable

boolean isMutable()

Tests whether is this stream mutable or not

Returns:

If this stream is mutable or not

isEmpty

boolean isEmpty()

Tests whether is this stream empty or not.

This is equivalent to String.isEmpty()

Returns:

If this stream empty or not