ReaderCursor (dbrain-data 0.20 API)

java.lang.Object
- org.dbrain.data.text.ReaderCursor

All Implemented Interfaces:

AutoCloseable
```
public class ReaderCursor
extends Object
implements AutoCloseable
```
Helper class to build recursive parsing routines. This class holds the "current" character in a buffer that can be read multiple times without affecting the underlying reader.

Constructor Summary

Constructors
Constructor and Description
`ReaderCursor(Reader r)` Creates a new instance of ReaderCursor using the underlying Reader as it's datasource.
`ReaderCursor(String s)` Create a cursor from a string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the underlying reader.
`int`	`current()`
`boolean`	`eof()`
`ParseException`	`error(String message)`
`ParseException`	`error(String message, Throwable e)`
`boolean`	`is(IntPredicate predicate)`
`boolean`	`is(String chars)`
`int`	`next()` Move cursor forward one position and get the character.
`int`	`read()`
`String`	`read(int count)`
`void`	`skip(String which)` Skip a character if it is contained into the passed string.
`String`	`toString()`

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

- Constructor Detail
  - ReaderCursor
```
public ReaderCursor(Reader r)
```
    Creates a new instance of ReaderCursor using the underlying Reader as it's datasource.
  - ReaderCursor
```
public ReaderCursor(String s)
```
    Create a cursor from a string.
- Method Detail
  - error
```
public ParseException error(String message,
                            Throwable e)
```
    Parameters:
    
    message - The message.
    
    Returns:
    
    A parse exception with the specified message.
  - error
```
public ParseException error(String message)
```
    Parameters:
    
    message - The message.
    
    Returns:
    
    A parse exception with the specified message.
  - current
```
public int current()
```
    Returns:
    
    The codepoint at the current cursor position. Note: If the current character is consumed, then one is loaded from the underlying reader.
  - is
```
public boolean is(IntPredicate predicate)
```
    Returns:
    
    true if the current character test true with the predicate.
  - is
```
public boolean is(String chars)
```
    Returns:
    
    true if the current character is one of the character in the string.
  - next
```
public int next()
```
    Move cursor forward one position and get the character. If the cursor has never red a character before, this method will return the first character.
    
    Returns:
    
    The next available character or -1 if none.
  - read
```
public int read()
```
    Returns:
    
    The current character and move the cursor forward.
  - read
```
public String read(int count)
```
    Returns:
    
    A string of characters. This method can return more characters than asked since it counts codepoints.
  - skip
```
public void skip(String which)
```
    Skip a character if it is contained into the passed string.
    
    Parameters:
    
    which -
  - eof
```
public boolean eof()
```
    Returns:
    
    true if at end of file.
  - close
```
public void close()
           throws Exception
```
    Close the underlying reader.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ReaderCursor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReaderCursor

ReaderCursor

Method Detail

error

error

current

is

is

next

read

read

skip

eof

close

toString