ReaderCursor (dbrain-data 0.7 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.
`ParseException`	`error(String message)` An exception with the specified message.
`ParseException`	`error(String message, Throwable e)` An exception with the specified message.
`int`	`get()`
`int`	`getNext()` Move cursor forward one position and get the character.
`int`	`read()`
`String`	`read(int count)`
`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)
```
    An exception with the specified message.
    
    Parameters:
    
    message - The message.
  - error
```
public ParseException error(String message)
```
    An exception with the specified message.
    
    Parameters:
    
    message - The message.
  - get
```
public int get()
```
    Returns:
    
    Get at the character at the current cursor position. Note: If the current character is consumed. The next one is loaded from the underlying reader.
  - getNext
```
public int getNext()
```
    Move cursor forward one position and get the 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.
  - 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

get

getNext

read

read

close

toString