public interface InputBuffer
Modifier and Type | Method and Description |
---|---|
char |
charAt(int index)
Returns the character at the given index.
|
java.lang.String |
extract(IndexRange range)
Constructs a new
String from all character covered by the given IndexRange. |
java.lang.String |
extract(int start,
int end)
Constructs a new
String from all character between the given indices. |
java.lang.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.
|
int |
getOriginalIndex(int index)
Translates the given index from the scope of this InputBuffer to the scope of the original, underlying char
array.
|
Position |
getPosition(int index)
Returns the line and column number of the character with the given index encapsulated in a
Position
object. |
boolean |
test(int index,
char[] characters)
Determines whether the characters starting at the given index match the ones from the given array (in order).
|
char charAt(int index)
Chars.EOI
.index
- the indexboolean test(int index, char[] characters)
index
- the index into the input buffer where to start the comparisoncharacters
- the characters to test against the input bufferjava.lang.String extract(int start, int end)
String
from all character between the given indices.
Invalid indices are automatically adjusted to their respective boundary.start
- the start index (inclusively)end
- the end index (exclusively)java.lang.String extract(IndexRange range)
String
from all character covered by the given IndexRange.range
- the IndexRangePosition getPosition(int index)
Position
object. The very first character has the line number 1 and the column number 1.index
- the index of the character to get the line number ofint getOriginalIndex(int index)
DefaultInputBuffer
implementation simply returns the given index, but other implementations
like the IndentDedentInputBuffer
or the MutableInputBuffer
need to "undo" all compressions and
index shiftings performed internally in order to return the underlying index.index
- the index relative to this InputBufferjava.lang.String extractLine(int lineNumber)
String
containing all characters with the given line number except for the trailing
newline.lineNumber
- the line number to getint getLineCount()