MutableStringStreamImpl (common 4.0.0-beta.17 API)

java.lang.Object
- revxrsal.commands.stream.MutableStringStreamImpl

All Implemented Interfaces:: MutableStringStream, StringStream

public final class MutableStringStreamImpl
extends java.lang.Object
implements MutableStringStream

Field Summary

Fields
Modifier and Type	Field and Description
`protected static char`	`DOUBLE_QUOTE` The character for quoting
`protected static char`	`ESCAPE` The escape character
`protected int`	`pos` The current reading position
`protected java.lang.String`	`source` The source string being read

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canRead(int characters)` Tests whether the stream can read the given `characters` count
`@NotNull java.lang.String`	`consumeRemaining()` Consumes the rest of the stream
`void`	`extend(@NotNull java.lang.String str)`
`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
`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`	`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
`char`	`read()`
`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()`
`@NotNull java.lang.String`	`readUnquotedString()`
`@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`.
`int`	`remaining()` Returns the characters remaining
`void`	`setPosition(int pos)` Sets the current position of the cursor
`void`	`skipToEnd()` Skips to the end of the stream
`void`	`skipWhitespace()` Skips all the upcoming whitespace
`@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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface revxrsal.commands.stream.MutableStringStream
read, readString, readUnquotedString, toImmutableCopy, toMutableCopy

Methods inherited from interface revxrsal.commands.stream.StringStream
canRead, create, create, createMutable, createMutable, hasFinished, hasRemaining, isEmpty, peek, peek, peekOffset, peekRemaining, peekString, peekUnquotedString, position, remaining, source, totalSize

- Field Detail
  - ESCAPE
```
protected static final char ESCAPE
```
    The escape character
    
    See Also:
    
    Constant Field Values
  - DOUBLE_QUOTE
```
protected static final char DOUBLE_QUOTE
```
    The character for quoting
    
    See Also:
    
    Constant Field Values
  - source
```
protected java.lang.String source
```
    The source string being read
  - pos
```
protected int pos
```
    The current reading position
- Method Detail
  - read
```
public java.lang.String read(int characters)
```
    Description copied from interface: MutableStringStream
    
    Reads the given number of characters, and moves the cursor forward.
    
    Specified by:
    
    read in interface MutableStringStream
    
    Returns:
    
    The number of characters to read
  - moveForward
```
public void moveForward()
```
    Description copied from interface: MutableStringStream
    
    Moves the cursor 1 step forward
    
    Specified by:
    
    moveForward in interface MutableStringStream
  - skipWhitespace
```
public void skipWhitespace()
```
    Description copied from interface: MutableStringStream
    
    Skips all the upcoming whitespace
    
    Specified by:
    
    skipWhitespace in interface MutableStringStream
  - moveBackward
```
public void moveBackward()
```
    Description copied from interface: MutableStringStream
    
    Moves the cursor 1 step backward
    
    Specified by:
    
    moveBackward in interface MutableStringStream
  - moveForward
```
public void moveForward(int by)
```
    Description copied from interface: MutableStringStream
    
    Moves the cursor by the given steps forward
    
    Specified by:
    
    moveForward in interface MutableStringStream
    
    Parameters:
    
    by - Steps to move
  - moveBackward
```
public void moveBackward(int by)
```
    Description copied from interface: MutableStringStream
    
    Moves the cursor by the given steps backward
    
    Specified by:
    
    moveBackward in interface MutableStringStream
    
    Parameters:
    
    by - Steps to move
  - consumeRemaining
```
@NotNull
public @NotNull java.lang.String consumeRemaining()
```
    Description copied from interface: MutableStringStream
    
    Consumes the rest of the stream
    
    Specified by:
    
    consumeRemaining in interface MutableStringStream
    
    Returns:
    
    The remaining string
  - skipToEnd
```
public void skipToEnd()
```
    Description copied from interface: MutableStringStream
    
    Skips to the end of the stream
    
    Specified by:
    
    skipToEnd in interface MutableStringStream
  - extend
```
@ApiStatus.Internal
public void extend(@NotNull
                                       @NotNull java.lang.String str)
```
  - readUntil
```
@NotNull
public @NotNull java.lang.String readUntil(char delimiter)
```
    Description copied from interface: MutableStringStream
    
    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.
    
    Specified by:
    
    readUntil in interface MutableStringStream
    
    Parameters:
    
    delimiter - Delimiter character
    
    Returns:
    
    The read string
  - readWhile
```
@NotNull
public @NotNull java.lang.String readWhile(CharPredicate predicate)
```
    Description copied from interface: MutableStringStream
    
    Reads from the text stream until the given predicate returns false.
    
    Specified by:
    
    readWhile in interface MutableStringStream
    
    Parameters:
    
    predicate - Predicate to test with
    
    Returns:
    
    The read string.
  - readFloat
```
public float readFloat()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as a float.
    
    Specified by:
    
    readFloat in interface MutableStringStream
    
    Returns:
    
    The next token, as a float.
  - readDouble
```
public double readDouble()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as a double.
    
    Specified by:
    
    readDouble in interface MutableStringStream
    
    Returns:
    
    The next token, as a double.
  - readInt
```
public int readInt()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as an int.
    
    Specified by:
    
    readInt in interface MutableStringStream
    
    Returns:
    
    The next token, as an int.
  - readLong
```
public long readLong()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as a long.
    
    Specified by:
    
    readLong in interface MutableStringStream
    
    Returns:
    
    The next token, as a long.
  - readShort
```
public short readShort()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as a short.
    
    Specified by:
    
    readShort in interface MutableStringStream
    
    Returns:
    
    The next token, as a short.
  - readByte
```
public byte readByte()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as a byte.
    
    Specified by:
    
    readByte in interface MutableStringStream
    
    Returns:
    
    The next token, as a byte.
  - readBoolean
```
public boolean readBoolean()
```
    Description copied from interface: MutableStringStream
    
    Parses the next token as a boolean.
    
    Specified by:
    
    readBoolean in interface MutableStringStream
    
    Returns:
    
    The next token, as a boolean.
  - setPosition
```
public void setPosition(int pos)
```
    Description copied from interface: MutableStringStream
    
    Sets the current position of the cursor
    
    Specified by:
    
    setPosition in interface MutableStringStream
    
    Parameters:
    
    pos - The cursor position
  - isMutable
```
public boolean isMutable()
```
    Tests whether is this stream mutable or not
    
    Specified by:
    
    isMutable in interface StringStream
    
    Returns:
    
    If this stream is mutable or not
  - source
```
@NotNull
public @NotNull java.lang.String source()
```
    Description copied from interface: StringStream
    
    Returns the original entire string source.
    
    Specified by:
    
    source in interface StringStream
    
    Returns:
    
    The string source
  - totalSize
```
public int totalSize()
```
    Description copied from interface: StringStream
    
    Returns the size of the source
    
    Specified by:
    
    totalSize in interface StringStream
    
    Returns:
    
    The source size
  - remaining
```
public int remaining()
```
    Description copied from interface: StringStream
    
    Returns the characters remaining
    
    Specified by:
    
    remaining in interface StringStream
    
    Returns:
    
    The number of characters remaining
  - peek
```
@Contract(pure=true)
public char peek()
```
    Description copied from interface: StringStream
    
    Peeks the next character, without moving the cursor forward.
    
    Specified by:
    
    peek in interface StringStream
    
    Returns:
    
    The next character
  - peek
```
public java.lang.String peek(int characters)
```
    Description copied from interface: StringStream
    
    Peeks the next number of character, without moving the cursor forward.
    
    Specified by:
    
    peek in interface StringStream
    
    Returns:
    
    The number of characters to peek
  - peekOffset
```
@Contract(pure=true)
public char peekOffset(int offset)
```
    Description copied from interface: StringStream
    
    Peeks the character after offset chars, without moving the cursor forward.
    
    Specified by:
    
    peekOffset in interface StringStream
    
    Parameters:
    
    offset - Characters to peek
    
    Returns:
    
    The next character
  - hasRemaining
```
public boolean hasRemaining()
```
    Description copied from interface: StringStream
    
    Tests whether there are any characters left in the string stream
    
    Specified by:
    
    hasRemaining in interface StringStream
    
    Returns:
    
    if there are any characters left
  - hasFinished
```
public boolean hasFinished()
```
    Description copied from interface: StringStream
    
    Tests whether this stream has finished parsing or not
    
    Specified by:
    
    hasFinished in interface StringStream
    
    Returns:
    
    If the stream has finished or not
  - canRead
```
public boolean canRead(int characters)
```
    Description copied from interface: StringStream
    
    Tests whether the stream can read the given characters count
    
    Specified by:
    
    canRead in interface StringStream
    
    Parameters:
    
    characters - Number of characters
    
    Returns:
    
    if such a number can be read or not.
  - position
```
public int position()
```
    Description copied from interface: StringStream
    
    Returns the cursor position
    
    Specified by:
    
    position in interface StringStream
    
    Returns:
    
    The cursor position
  - readUnquotedString
```
@NotNull
public @NotNull java.lang.String readUnquotedString()
```
  - readString
```
@NotNull
public @NotNull java.lang.String readString()
```
  - read
```
public char read()
```
  - peekString
```
@NotNull
public @NotNull java.lang.String peekString()
```
    Description copied from interface: StringStream
    
    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.
    
    Specified by:
    
    peekString in interface StringStream
    
    Returns:
    
    The next string.
  - peekUnquotedString
```
@NotNull
public @NotNull java.lang.String peekUnquotedString()
```
    Description copied from interface: StringStream
    
    Peeks a single, unquoted string. This will simply move forward until it encounters a whitespace character.
    This will not move the cursor forward.
    
    Specified by:
    
    peekUnquotedString in interface StringStream
    
    Returns:
    
    The peeked string
  - peekRemaining
```
@NotNull
public @NotNull java.lang.String peekRemaining()
```
    Description copied from interface: StringStream
    
    Peeks the remainder of the string stream
    
    Specified by:
    
    peekRemaining in interface StringStream
    
    Returns:
    
    The peeked string
  - toImmutableCopy
```
@NotNull
public @NotNull @Unmodifiable StringStream toImmutableCopy()
```
    Description copied from interface: StringStream
    
    Returns an StringStream copy of this string stream
    
    Specified by:
    
    toImmutableCopy in interface StringStream
    
    Returns:
    
    an immutable copy of this.
  - toMutableCopy
```
@NotNull
 @Contract(value="-> new",
          pure=true)
public @NotNull MutableStringStream toMutableCopy()
```
    Description copied from interface: StringStream
    
    Returns a new, mutable MutableStringStream copy of this stream.
    
    Specified by:
    
    toMutableCopy in interface StringStream
    
    Returns:
    
    The new string stream
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: StringStream
    
    Tests whether is this stream empty or not.
    This is equivalent to String.isEmpty()
    
    Specified by:
    
    isEmpty in interface StringStream
    
    Returns:
    
    If this stream empty or not

Class MutableStringStreamImpl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface revxrsal.commands.stream.MutableStringStream

Methods inherited from interface revxrsal.commands.stream.StringStream

Field Detail

ESCAPE

DOUBLE_QUOTE

source

pos

Method Detail

read

moveForward

skipWhitespace

moveBackward

moveForward

moveBackward

consumeRemaining

skipToEnd

extend

readUntil

readWhile

readFloat

readDouble

readInt

readLong

readShort

readByte

readBoolean

setPosition

isMutable

source

totalSize

remaining

peek

peek

peekOffset

hasRemaining

hasFinished

canRead

position

readUnquotedString

readString

read

peekString

peekUnquotedString

peekRemaining

toImmutableCopy

toMutableCopy

isEmpty