StringReader (CommandLib 1.0.0 API)

java.lang.Object
- net.lenni0451.commandlib.utils.StringReader

public class StringReader
extends java.lang.Object

A simple string reader used for parsing arguments.

Constructor Summary

Constructors
Constructor and Description

StringReader(java.lang.String string)

Constructors
Constructor and Description
`StringReader(java.lang.String string)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canRead()`
`boolean`	`canRead(int length)` Get if the reader can read the given amount of characters.
`StringReader`	`ensureLength(int length)` Ensure that the reader can read the given amount of characters.
`int`	`getCursor()`
`java.lang.String`	`getString()`
`int`	`length()`
`char`	`peek()`
`char`	`peek(int offset)` Get the character with the given offset without moving the cursor.
`java.lang.String`	`peekRemaining()`
`char`	`read()`
`java.lang.String`	`read(int length)` Read the given amount of characters and move the cursor by the given amount of characters.
`java.lang.String`	`readDecimalNumber()` Read a word and ensure that it is a valid decimal number.
`java.lang.String`	`readIntegerNumber()` Read a word and ensure that it is a valid integer number.
`java.lang.String`	`readRemaining()`
`java.lang.String`	`readString()` Read a string starting with a single or double quote.
`java.lang.String`	`readUntil(char c)` Read until the given character is found or the end of the string is reached.
`java.lang.String`	`readUntil(char c, boolean allowEscape)` Read until the given character is found or the end of the string is reached.
`java.lang.String`	`readWord()` Read a word until the next whitespace character is found.
`java.lang.String`	`readWordOrString()` Read a word or a string if the next character is a single or double quote.
`int`	`remaining()`
`StringReader`	`require(char... cs)` Require the next character to be in the given array.
`StringReader`	`setCursor(int cursor)` Set the cursor position.
`StringReader`	`skip()` Move the cursor by one character.
`StringReader`	`skip(int length)` Move the cursor by the given amount of characters.
`StringReader`	`skipRequiredWhitespace()` Skip all whitespace characters and ensure that at least one character was skipped.
`StringReader`	`skipRequiredWhitespaceOrEOL()` Skip all whitespace characters and ensure that at least one character was skipped.
`StringReader`	`skipWhitespace()` Skip all 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 string)
```
- Method Detail
  - getString
```
public java.lang.String getString()
```
    Returns:
    
    The string that is read
  - getCursor
```
public int getCursor()
```
    Returns:
    
    The current cursor position
  - setCursor
```
public StringReader setCursor(int cursor)
```
    Set the cursor position.
    
    Parameters:
    
    cursor - The new cursor position
    
    Returns:
    
    The string reader
  - length
```
public int length()
```
    Returns:
    
    The length of the string
  - remaining
```
public int remaining()
```
    Returns:
    
    The amount of remaining characters
  - canRead
```
public boolean canRead()
```
    Returns:
    
    If the reader can read at least one character
  - canRead
```
public boolean canRead(int length)
```
    Get if the reader can read the given amount of characters.
    
    Parameters:
    
    length - The amount of characters
    
    Returns:
    
    If the reader can read the given amount of characters
  - ensureLength
```
public StringReader ensureLength(int length)
```
    Ensure that the reader can read the given amount of characters.
    
    Parameters:
    
    length - The amount of characters
    
    Returns:
    
    The string reader
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - If the reader cannot read the given amount of characters
  - require
```
public StringReader require(char... cs)
```
    Require the next character to be in the given array.
    
    Parameters:
    
    cs - The array of characters
    
    Returns:
    
    The string reader
    
    Throws:
    
    java.lang.IllegalStateException - If the nothing can be read or the next character is not in the given array
  - peek
```
public char peek()
```
    Returns:
    
    The next character without moving the cursor
  - peek
```
public char peek(int offset)
```
    Get the character with the given offset without moving the cursor.
    
    Parameters:
    
    offset - The offset
    
    Returns:
    
    The character with the given offset
  - peekRemaining
```
public java.lang.String peekRemaining()
```
    Returns:
    
    The remaining string without moving the cursor
  - skipWhitespace
```
public StringReader skipWhitespace()
```
    Skip all whitespace characters.
    If nothing can be read, nothing will happen.
    
    Returns:
    
    The string reader
  - skipRequiredWhitespace
```
public StringReader skipRequiredWhitespace()
```
    Skip all whitespace characters and ensure that at least one character was skipped.
    If nothing can be read, an exception will be thrown.
    
    Returns:
    
    The string reader
    
    Throws:
    
    java.lang.IllegalStateException - If nothing can be read or the next character is not a whitespace character
  - skipRequiredWhitespaceOrEOL
```
public StringReader skipRequiredWhitespaceOrEOL()
```
    Skip all whitespace characters and ensure that at least one character was skipped.
    If nothing can be read, nothing will happen.
    
    Returns:
    
    The string reader
    
    Throws:
    
    java.lang.IllegalStateException - If the next character is not a whitespace character
  - skip
```
public StringReader skip()
```
    Move the cursor by one character.
    
    Returns:
    
    The string reader
  - skip
```
public StringReader skip(int length)
```
    Move the cursor by the given amount of characters.
    
    Parameters:
    
    length - The amount of characters
    
    Returns:
    
    The string reader
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - If the given amount of characters is not available
  - read
```
public char read()
```
    Returns:
    
    The next character and move the cursor by one character
  - read
```
public java.lang.String read(int length)
```
    Read the given amount of characters and move the cursor by the given amount of characters.
    
    Parameters:
    
    length - The amount of characters
    
    Returns:
    
    The read characters
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - If the given amount of characters is not available
  - readUntil
```
public java.lang.String readUntil(char c)
```
    Read until the given character is found or the end of the string is reached.
    The character will not be read.
    
    Parameters:
    
    c - The character
    
    Returns:
    
    The read characters
  - readUntil
```
public java.lang.String readUntil(char c,
                                  boolean allowEscape)
```
    Read until the given character is found or the end of the string is reached.
    The character will not be read.
    If the given character is escaped using a backslash, it will be ignored. The backslash will be removed.
    
    Parameters:
    
    c - The character
    
    allowEscape - Whether to allow escaping
    
    Returns:
    
    The read characters
  - readRemaining
```
public java.lang.String readRemaining()
```
    Returns:
    
    The remaining string and move the cursor to the end of the string
  - readWord
```
public java.lang.String readWord()
```
    Read a word until the next whitespace character is found.
    
    Returns:
    
    The next word
  - readString
```
public java.lang.String readString()
```
    Read a string starting with a single or double quote.
    The quotes will be removed.
    
    Returns:
    
    The read string
    
    Throws:
    
    java.lang.IllegalStateException - If the end of the string is reached without finding a closing quote
  - readWordOrString
```
public java.lang.String readWordOrString()
```
    Read a word or a string if the next character is a single or double quote.
    
    Returns:
    
    The read word or string
    
    Throws:
    
    java.lang.IllegalStateException - If the end of the string is reached without finding a closing quote (if a string is read)
  - readIntegerNumber
```
public java.lang.String readIntegerNumber()
```
    Read a word and ensure that it is a valid integer number.
    
    Returns:
    
    The unparsed integer number
  - readDecimalNumber
```
public java.lang.String readDecimalNumber()
```
    Read a word and ensure that it is a valid decimal number.
    
    Returns:
    
    The unparsed decimal number

Class StringReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringReader

Method Detail

getString

getCursor

setCursor

length

remaining

canRead

canRead

ensureLength

require

peek

peek

peekRemaining

skipWhitespace

skipRequiredWhitespace

skipRequiredWhitespaceOrEOL

skip

skip

read

read

readUntil

readUntil

readRemaining

readWord

readString

readWordOrString

readIntegerNumber

readDecimalNumber