All Implemented Interfaces:
```
public final class Cursor

                    
```
Class representing an iteration position over a given string, with convenience functions. This is intended for use with the token parsing system, but you can use it for other things too.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Integer`	`index`
`private final Boolean`	`hasNext`
`private final Boolean`	`hasPrevious`
`private final String`	`input`

Constructor Summary

Constructors
Constructor	Description
`Cursor(String input)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getIndex()`	Current iteration index, starting at `-1`.
`final Unit`	`setIndex(Integer index)`	Current iteration index, starting at `-1`.
`final Boolean`	`getHasNext()`
`final Boolean`	`getHasPrevious()`
`final String`	`getInput()`
`final String`	`consumeNumber(Integer amount)`	Consume amount characters from this cursor, returning them as a String.
`final String`	`consumeRemaining()`	Iterate over the rest of the string, returning the result.
`final String`	`consumeWhile(Function1<Character, Boolean> predicate)`	Iterate over the rest of the string as long as the predicate returns `true`, returning the result.
`final Boolean`	`skipWhitespace()`	Skip any immediate whitespace, updating the index.
`final Character`	`next()`	Increment the index and return the character found there, throwing if we're at the end of the string.
`final Character`	`nextOrNull()`	Increment the index and return the character found there, or `null` if we're at the end of the string.
`final Character`	`previous()`	Decrement the index and return the character found there, throwing if we're at the start of the string.
`final Character`	`previousOrNull()`	Decrement the index and return the character found there, or `null` if we're at the start of the string.
`final Character`	`peek()`	Return the character at the current index.
`final Character`	`peekNext()`	Return the character at the next index, or `null` if we're at the end of the string.
`final Character`	`peekPrevious()`	Return the character at the previous index, or `null` if we're at the start of the string.

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

- Constructor Detail
  - Cursor
```
Cursor(String input)
```
    Parameters:
    
    input - Input string to iterate over.
- Method Detail
  - getIndex
```
 final Integer getIndex()
```
    Current iteration index, starting at -1.
  - setIndex
```
 final Unit setIndex(Integer index)
```
    Current iteration index, starting at -1.
  - getHasNext
```
 final Boolean getHasNext()
```
  - getHasPrevious
```
 final Boolean getHasPrevious()
```
  - getInput
```
 final String getInput()
```
  - consumeNumber
```
 final String consumeNumber(Integer amount)
```
    Consume amount characters from this cursor, returning them as a String. Will stop consuming and return when the cursor runs out of characters, instead of throwing.
    Returns an empty string if no characters remain.
  - consumeRemaining
```
 final String consumeRemaining()
```
    Iterate over the rest of the string, returning the result.
  - consumeWhile
```
 final String consumeWhile(Function1<Character, Boolean> predicate)
```
    Iterate over the rest of the string as long as the predicate returns true, returning the result.
  - skipWhitespace
```
 final Boolean skipWhitespace()
```
    Skip any immediate whitespace, updating the index.
  - next
```
 final Character next()
```
    Increment the index and return the character found there, throwing if we're at the end of the string.
  - nextOrNull
```
 final Character nextOrNull()
```
    Increment the index and return the character found there, or null if we're at the end of the string.
  - previous
```
 final Character previous()
```
    Decrement the index and return the character found there, throwing if we're at the start of the string.
  - previousOrNull
```
 final Character previousOrNull()
```
    Decrement the index and return the character found there, or null if we're at the start of the string.
  - peek
```
 final Character peek()
```
    Return the character at the current index.
  - peekNext
```
 final Character peekNext()
```
    Return the character at the next index, or null if we're at the end of the string.
  - peekPrevious
```
 final Character peekPrevious()
```
    Return the character at the previous index, or null if we're at the start of the string.

Class Cursor

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cursor

Method Detail

getIndex

setIndex

getHasNext

getHasPrevious

getInput

consumeNumber

consumeRemaining

consumeWhile

skipWhitespace

next

nextOrNull

previous

previousOrNull

peek

peekNext

peekPrevious