org.antlr.v4.runtime

类 ANTLRInputStream

java.lang.Object

org.antlr.v4.runtime.ANTLRInputStream

所有已实现的接口:

CharStream, IntStream, UnicodeCharStream

直接已知子类:

ANTLRFileStream

已过时。

as of 4.7 Please use CharStreams interface.

@Deprecated
public class ANTLRInputStream
extends Object
implements UnicodeCharStream, CharStream

Vacuum all input from a Reader/InputStream and then treat it like a char[] buffer. Can also pass in a String or char[] to use.

If you need encoding, pass in stream/reader with correct encoding.

字段概要

字段

限定符和类型	字段和说明
protected char[]	data 已过时。 The data being scanned
static int	INITIAL_BUFFER_SIZE 已过时。
protected int	n 已过时。 How many characters are actually in the buffer
String	name 已过时。 What is name or source of this char stream?
protected int	p 已过时。 0..n-1 index into string of next char
static int	READ_BUFFER_SIZE 已过时。

从接口继承的字段 org.antlr.v4.runtime.IntStream

EOF, UNKNOWN_SOURCE_NAME

构造器概要

构造器

构造器和说明
ANTLRInputStream() 已过时。
ANTLRInputStream(char[] data, int numberOfActualCharsInArray) 已过时。 This is the preferred constructor for strings as no data is copied
ANTLRInputStream(InputStream input) 已过时。
ANTLRInputStream(InputStream input, int initialSize) 已过时。
ANTLRInputStream(InputStream input, int initialSize, int readChunkSize) 已过时。
ANTLRInputStream(Reader r) 已过时。
ANTLRInputStream(Reader r, int initialSize) 已过时。
ANTLRInputStream(Reader r, int initialSize, int readChunkSize) 已过时。
ANTLRInputStream(String input) 已过时。 Copy data in string to a local char array

方法概要

限定符和类型	方法和说明
void	consume() 已过时。 Consumes the current symbol in the stream.
String	getSourceName() 已过时。 Gets the name of the underlying symbol source.
String	getText(Interval interval) 已过时。 This method returns the text for a range of characters within this input stream.
int	index() 已过时。 Return the current input symbol index 0..n where n indicates the last symbol has been read.
int	LA(int i) 已过时。 Gets the value of the symbol at offset i from the current position.
void	load(Reader r, int size, int readChunkSize) 已过时。
int	LT(int i) 已过时。
int	mark() 已过时。 mark/release do nothing; we have entire buffer
void	release(int marker) 已过时。 This method releases a marked range created by a call to mark().
void	reset() 已过时。 Reset the stream so that it's in the same state it was when the object was created *except* the data array is not touched.
void	seek(int index) 已过时。 consume() ahead until p==index; can't just set p=index as we must update line and charPositionInLine.
int	size() 已过时。 Returns the total number of symbols in the stream, including a single EOF symbol.
boolean	supportsUnicodeCodePoints() 已过时。 Determines if the current stream supports Unicode code points.
String	toString() 已过时。

从类继承的方法 java.lang.Object

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

字段详细资料

READ_BUFFER_SIZE

public static final int READ_BUFFER_SIZE

已过时。

另请参阅:

常量字段值

INITIAL_BUFFER_SIZE

public static final int INITIAL_BUFFER_SIZE

已过时。

另请参阅:

常量字段值

data

protected char[] data

已过时。

The data being scanned

n

protected int n

已过时。

How many characters are actually in the buffer

p

protected int p

已过时。

0..n-1 index into string of next char

name

public String name

已过时。

What is name or source of this char stream?

构造器详细资料

ANTLRInputStream

public ANTLRInputStream()

已过时。

ANTLRInputStream

public ANTLRInputStream(String input)

已过时。

Copy data in string to a local char array

ANTLRInputStream

public ANTLRInputStream(char[] data,
                        int numberOfActualCharsInArray)

已过时。

This is the preferred constructor for strings as no data is copied

ANTLRInputStream

public ANTLRInputStream(Reader r)
                 throws IOException

已过时。

抛出:

IOException

ANTLRInputStream

public ANTLRInputStream(Reader r,
                        int initialSize)
                 throws IOException

已过时。

抛出:

IOException

ANTLRInputStream

public ANTLRInputStream(Reader r,
                        int initialSize,
                        int readChunkSize)
                 throws IOException

已过时。

抛出:

IOException

ANTLRInputStream

public ANTLRInputStream(InputStream input)
                 throws IOException

已过时。

抛出:

IOException

ANTLRInputStream

public ANTLRInputStream(InputStream input,
                        int initialSize)
                 throws IOException

已过时。

抛出:

IOException

ANTLRInputStream

public ANTLRInputStream(InputStream input,
                        int initialSize,
                        int readChunkSize)
                 throws IOException

已过时。

抛出:

IOException

方法详细资料

load

public void load(Reader r,
                 int size,
                 int readChunkSize)
          throws IOException

已过时。

抛出:

IOException

reset

public void reset()

已过时。

Reset the stream so that it's in the same state it was when the object was created *except* the data array is not touched.

consume

public void consume()

已过时。

从接口复制的说明: IntStream

Consumes the current symbol in the stream. This method has the following effects:

• Forward movement: The value of index() before calling this method is less than the value of index() after calling this method.
• Ordered lookahead: The value of LA(1) before calling this method becomes the value of LA(-1) after calling this method.

Note that calling this method does not guarantee that index() is incremented by exactly 1, as that would preclude the ability to implement filtering streams (e.g. CommonTokenStream which distinguishes between "on-channel" and "off-channel" tokens).

指定者:

consume 在接口中 IntStream

LA

public int LA(int i)

已过时。

从接口复制的说明: IntStream

Gets the value of the symbol at offset i from the current position. When i==1, this method returns the value of the current symbol in the stream (which is the next symbol to be consumed). When i==-1, this method returns the value of the previously read symbol in the stream. It is not valid to call this method with i==0, but the specific behavior is unspecified because this method is frequently called from performance-critical code.

This method is guaranteed to succeed if any of the following are true:

• i>0
• i==-1 and index() returns a value greater than the value of index() after the stream was constructed and LA(1) was called in that order. Specifying the current index() relative to the index after the stream was created allows for filtering implementations that do not return every symbol from the underlying source. Specifying the call to LA(1) allows for lazily initialized streams.
• LA(i) refers to a symbol consumed within a marked region that has not yet been released.

If i represents a position at or beyond the end of the stream, this method returns IntStream.EOF.

The return value is unspecified if i<0 and fewer than -i calls to consume() have occurred from the beginning of the stream before calling this method.

指定者:

LA 在接口中 IntStream

LT

public int LT(int i)

已过时。

index

public int index()

已过时。

Return the current input symbol index 0..n where n indicates the last symbol has been read. The index is the index of char to be returned from LA(1).

指定者:

index 在接口中 IntStream

size

public int size()

已过时。

从接口复制的说明: IntStream

Returns the total number of symbols in the stream, including a single EOF symbol.

指定者:

size 在接口中 IntStream

mark

public int mark()

已过时。

mark/release do nothing; we have entire buffer

指定者:

mark 在接口中 IntStream

返回:

An opaque marker which should be passed to release() when the marked range is no longer required.

release

public void release(int marker)

已过时。

从接口复制的说明: IntStream

This method releases a marked range created by a call to mark(). Calls to release() must appear in the reverse order of the corresponding calls to mark(). If a mark is released twice, or if marks are not released in reverse order of the corresponding calls to mark(), the behavior is unspecified.

For more information and an example, see IntStream.mark().

指定者:

release 在接口中 IntStream

参数:

marker - A marker returned by a call to mark().

另请参阅:

IntStream.mark()

seek

public void seek(int index)

已过时。

consume() ahead until p==index; can't just set p=index as we must update line and charPositionInLine. If we seek backwards, just set p

指定者:

seek 在接口中 IntStream

参数:

index - The absolute index to seek to.

getText

public String getText(Interval interval)

已过时。

从接口复制的说明: CharStream

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().

指定者:

getText 在接口中 CharStream

参数:

interval - an interval within the stream

返回:

the text of the specified interval

getSourceName

public String getSourceName()

已过时。

从接口复制的说明: 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.

指定者:

getSourceName 在接口中 IntStream

toString

public String toString()

已过时。

覆盖:

toString 在类中 Object

supportsUnicodeCodePoints

public boolean supportsUnicodeCodePoints()

已过时。

Determines if the current stream supports Unicode code points.

指定者:

supportsUnicodeCodePoints 在接口中 UnicodeCharStream

返回:

true if the current input stream supports Unicode code points; otherwise, false if the current input stream returns UTF-16 code units for code points above U+FFFF.