org.antlr.v4.runtime

Interface CharStream

All Superinterfaces:

IntStream

All Known Implementing Classes:

ANTLRFileStream, ANTLRInputStream, UnbufferedCharStream

public interface CharStream
extends IntStream

A source of characters for an ANTLR lexer.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CHAR The maximum allowed value for a character in a CharStream.
static int	MIN_CHAR The minimum allowed value for a character in a CharStream.

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

EOF, UNKNOWN_SOURCE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
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

Field Detail

MIN_CHAR

static final int MIN_CHAR

The minimum allowed value for a character in a CharStream.

See Also:

Constant Field Values

MAX_CHAR

static final int MAX_CHAR

The maximum allowed value for a character in a CharStream.

This value is Character.MAX_VALUE - 1, which reserves the value Character.MAX_VALUE for special use within an implementing class. For some implementations, the data buffers required for supporting the marked ranges of IntStream are stored as char[] instead of int[], with Character.MAX_VALUE being used instead of -1 to mark the end of the stream internally.

See Also:

Constant Field Values

Method Detail

getText

@NotNull
String getText(@NotNull
                     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:

NullPointerException - if interval is null

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

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