SeekableStringReader (serpent 1.23 API)

java.lang.Object
- net.razorvine.serpent.SeekableStringReader

```
public class SeekableStringReader
extends Object
```
A special string reader that is suitable for the parser to read through the expression string. You can rewind it, set bookmarks to flip back to, etc.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`SeekableStringReader.StringContext` Extract a piece of context around the current cursor (if you set cursor to -1) or around a given position in the string (if you set cursor>=0).

Constructor Summary

Constructors
Constructor and Description

SeekableStringReader(SeekableStringReader parent)
Make a nested reader with its own cursor and bookmark.

SeekableStringReader(String str)

Constructors
Constructor and Description
`SeekableStringReader(SeekableStringReader parent)` Make a nested reader with its own cursor and bookmark.
`SeekableStringReader(String str)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`bookmark()` Return a bookmark to rewind to later.
`void`	`close()`
`SeekableStringReader.StringContext`	`context(int crsr, int width)`
`void`	`flipBack(int bookmark)` Flip back to previously set bookmark.
`boolean`	`hasMore()` Is tehre more to read?
`char`	`peek()` What is the next character?
`String`	`peek(int count)` What are the next characters that will be read?
`char`	`read()` Read a single character.
`String`	`read(int count)` Read a number of characters.
`String`	`readUntil(char sentinel)` Read everything until one the sentinel, which must exist in the string.
`String`	`readUntil(String sentinels)` Read everything until one of the sentinel(s), which must exist in the string.
`String`	`readWhile(String accepted)` Read everything as long as the char occurs in the accepted characters.
`String`	`rest()` Returns the rest of the data until the end.
`void`	`rewind(int count)` Rewind a number of characters.
`void`	`skipWhitespace()` Read away any whitespace.
`void`	`sync(SeekableStringReader inner)` Sync the position and bookmark with the current position in another reader.

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

- Constructor Detail
  - SeekableStringReader
```
public SeekableStringReader(String str)
```
  - SeekableStringReader
```
public SeekableStringReader(SeekableStringReader parent)
```
    Make a nested reader with its own cursor and bookmark. The cursor starts at the same position as the parent.
- Method Detail
  - hasMore
```
public boolean hasMore()
```
    Is tehre more to read?
  - peek
```
public char peek()
```
    What is the next character?
  - peek
```
public String peek(int count)
```
    What are the next characters that will be read?
  - read
```
public char read()
```
    Read a single character.
  - read
```
public String read(int count)
```
    Read a number of characters.
  - readUntil
```
public String readUntil(char sentinel)
```
    Read everything until one the sentinel, which must exist in the string. Sentinel char is read but not returned in the result.
  - readUntil
```
public String readUntil(String sentinels)
```
    Read everything until one of the sentinel(s), which must exist in the string. Sentinel char is read but not returned in the result.
  - readWhile
```
public String readWhile(String accepted)
```
    Read everything as long as the char occurs in the accepted characters.
  - skipWhitespace
```
public void skipWhitespace()
```
    Read away any whitespace. If a comment follows ('# bla bla') read away that as well
  - rest
```
public String rest()
```
    Returns the rest of the data until the end.
  - rewind
```
public void rewind(int count)
```
    Rewind a number of characters.
  - bookmark
```
public int bookmark()
```
    Return a bookmark to rewind to later.
  - flipBack
```
public void flipBack(int bookmark)
```
    Flip back to previously set bookmark.
  - sync
```
public void sync(SeekableStringReader inner)
```
    Sync the position and bookmark with the current position in another reader.
  - context
```
public SeekableStringReader.StringContext context(int crsr,
                                                  int width)
```
  - close
```
public void close()
```

Class SeekableStringReader

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SeekableStringReader

SeekableStringReader

Method Detail

hasMore

peek

peek

read

read

readUntil

readUntil

readWhile

skipWhitespace

rest

rewind

bookmark

flipBack

sync

context

close