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 IntStream
EOF, UNKNOWN_SOURCE_NAME
Method Summary

Modifier and Type

Method

Description

String

getText(Interval interval)

This method returns the text for a range of characters within this input stream.

Methods inherited from interface IntStream
consume, getSourceName, index, LA, mark, release, seek, size

Method Details
- getText
  
  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:
  
  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