InputBuffer (grappa 2.0.4-SNAPSHOT API)

All Known Implementing Classes:

CharSequenceInputBuffer
```
public interface InputBuffer
```
Abstraction of a simple char[] buffer holding the input text to be parsed.

Method Summary

Methods
Modifier and Type	Method and Description
`char`	`charAt(int index)` Returns the character at the given index.
`int`	`codePointAt(int index)` Returns the Unicode code point starting at a given index
`String`	`extract(IndexRange range)` Constructs a new `String` from all character covered by the given IndexRange.
`String`	`extract(int start, int end)` Constructs a new `String` from all character between the given indices.
`String`	`extractLine(int lineNumber)` Constructs a new `String` containing all characters with the given line number except for the trailing newline.
`int`	`getLineCount()` Returns the number of lines in the input buffer.
`IndexRange`	`getLineRange(int lineNumber)` Get the index range matching a given line number
`Position`	`getPosition(int index)` Returns the line and column number of the character with the given index encapsulated in a `Position` object.
`int`	`length()`

- Method Detail
  - charAt
```
char charAt(int index)
```
    Returns the character at the given index.
    If the index is greater than, or equal to, the buffer's length, this method returns Chars.EOI.
    
    Parameters:
    index - the index
    
    Returns:
    the character at the given index or Chars.EOI.
    
    Throws:
    
    IllegalArgumentException - index is negative
  - codePointAt
```
int codePointAt(int index)
```
    Returns the Unicode code point starting at a given index
    If the index is greater than, or equal to, the buffer's length, this method returns -1.
    
    Parameters:
    index - the index
    
    Returns:
    the code point at this index, or -1 if the end of input has been reached
    
    Throws:
    
    IllegalArgumentException - index is negative
  - extract
```
String extract(int start,
             int end)
```
    Constructs a new String from all character between the given indices. Invalid indices are automatically adjusted to their respective boundary.
    
    Parameters:
    start - the start index (inclusively)
    end - the end index (exclusively)
    
    Returns:
    a new String (non-interned)
  - extract
```
String extract(IndexRange range)
```
    Constructs a new String from all character covered by the given IndexRange.
    
    Parameters:
    range - the IndexRange
    
    Returns:
    a new String (non-interned)
  - getPosition
```
Position getPosition(int index)
```
    Returns the line and column number of the character with the given index encapsulated in a Position object. The very first character has the line number 1 and the column number 1.
    
    Parameters:
    index - the index of the character to get the line number of
    
    Returns:
    the line number
  - extractLine
```
String extractLine(int lineNumber)
```
    Constructs a new String containing all characters with the given line number except for the trailing newline.
    
    Parameters:
    lineNumber - the line number to get
    
    Returns:
    the string
  - getLineRange
```
IndexRange getLineRange(int lineNumber)
```
    Get the index range matching a given line number
    
    Parameters:
    lineNumber - the line number
    
    Returns:
    the index range
  - getLineCount
```
int getLineCount()
```
    Returns the number of lines in the input buffer.
    
    Returns:
    number of lines in the input buffer.
  - length
```
int length()
```

Interface InputBuffer

Method Summary

Method Detail

charAt

codePointAt

extract

extract

getPosition

extractLine

getLineRange

getLineCount

length