org.antlr.v4.runtime

Interface CharStream

All Superinterfaces:

IntStream

All Known Implementing Classes:

ANTLRFileStream, ANTLRInputStream, CodePointCharStream, CodePointCharStream.CodePoint16BitCharStream, CodePointCharStream.CodePoint32BitCharStream, CodePointCharStream.CodePoint8BitCharStream, UnbufferedCharStream

public interface CharStream
extends IntStream

A source of characters for an ANTLR lexer.

Field Summary

Fields inherited from interface org.antlr.v4.runtime.IntStream

EOF, UNKNOWN_SOURCE_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getText(Interval interval) This method returns the text for a range of characters within this input stream.

Methods inherited from interface org.antlr.v4.runtime.IntStream

consume, getSourceName, index, LA, mark, release, seek, size

Method Detail

getText

java.lang.String getText(Interval interval)

This method returns the text for a range of characters within this input stream. This method is guaranteed to not throw an exception if the specified interval lies entirely within a marked range. For more information about marked ranges, see IntStream.mark().

Parameters:

interval - an interval within the stream

Returns:

the text of the specified interval

Throws:

java.lang.NullPointerException - if interval is null

java.lang.IllegalArgumentException - if interval.a < 0, or if interval.b < interval.a - 1, or if interval.b lies at or past the end of the stream

java.lang.UnsupportedOperationException - if the stream does not support getting the text of the specified interval