org.antlr.v4.runtime

Class ANTLRFileStream

java.lang.Object

org.antlr.v4.runtime.ANTLRInputStream

org.antlr.v4.runtime.ANTLRFileStream

All Implemented Interfaces:

CharStream, IntStream

public class ANTLRFileStream
extends ANTLRInputStream

This is an ANTLRInputStream that is loaded from a file all at once when you construct the object. This is a special case since we know the exact size of the object to load. We can avoid lots of data copying.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fileName

Fields inherited from class org.antlr.v4.runtime.ANTLRInputStream

data, INITIAL_BUFFER_SIZE, n, name, p, READ_BUFFER_SIZE

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

MAX_CHAR, MIN_CHAR

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

EOF, UNKNOWN_SOURCE_NAME

Constructor Summary

Constructors

Constructor and Description
ANTLRFileStream(String fileName)
ANTLRFileStream(String fileName, String encoding)

Method Summary

Methods

Modifier and Type	Method and Description
String	getSourceName() Gets the name of the underlying symbol source.
void	load(String fileName, String encoding)

Methods inherited from class org.antlr.v4.runtime.ANTLRInputStream

consume, getText, index, LA, load, LT, mark, release, reset, seek, size, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fileName

protected String fileName

Constructor Detail

ANTLRFileStream

public ANTLRFileStream(String fileName)
                throws IOException

Throws:

IOException

ANTLRFileStream

public ANTLRFileStream(String fileName,
               String encoding)
                throws IOException

Throws:

IOException

Method Detail

load

public void load(String fileName,
        String encoding)
          throws IOException

Throws:

IOException

getSourceName

public String getSourceName()

Description copied from interface: IntStream

Gets the name of the underlying symbol source. This method returns a non-null, non-empty string. If such a name is not known, this method returns IntStream.UNKNOWN_SOURCE_NAME.

Specified by:

getSourceName in interface IntStream

Overrides:

getSourceName in class ANTLRInputStream