public Class BufferedTokenStream

Implements org.antlr.v4.runtime.IntStream.consume.

Doc from org.antlr.v4.runtime.IntStream.consume.

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.

Annotations

@Override

Get all tokens from lexer until EOF.

Implements org.antlr.v4.runtime.TokenStream.get.

Doc from org.antlr.v4.runtime.TokenStream.get.

Gets the Token at the specified index in the stream. When the preconditions of this method are met, the return value is non-null.

The preconditions for this method are the same as the preconditions of IntStream#seek. If the behavior of seek(index) is unspecified for the current state and given index, then the behavior of this method is also unspecified.

The symbol referred to by index differs from seek() only in the case of filtering streams where index lies before the end of the stream. Unlike seek(), this method does not adjust index to point to a non-ignored symbol.

Annotations

@Override

Get all tokens from start..stop inclusively.

Collect all tokens on specified channel to the left of the current token up until we see a token on Lexer#DEFAULT_TOKEN_CHANNEL. If channel is -1, find any non default channel token.

Collect all hidden tokens (any off-default channel) to the left of the current token up until we see a token on Lexer#DEFAULT_TOKEN_CHANNEL.

Collect all tokens on specified channel to the right of the current token up until we see a token on Lexer#DEFAULT_TOKEN_CHANNEL or EOF. If channel is -1, find any non default channel token.

Collect all hidden tokens (any off-default channel) to the right of the current token up until we see a token on Lexer#DEFAULT_TOKEN_CHANNEL or EOF.

Implements org.antlr.v4.runtime.IntStream.getSourceName.

Doc from org.antlr.v4.runtime.IntStream.getSourceName.

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 UNKNOWN_SOURCE_NAME.

Annotations

@Override

Implements org.antlr.v4.runtime.TokenStream.getText.

Get the text of all tokens in this buffer.

Returns:String

Doc from org.antlr.v4.runtime.TokenStream.getText.

The text of all tokens in the stream.

Annotations

@NotNull

@Override

Implements org.antlr.v4.runtime.TokenStream.getText.

Doc from org.antlr.v4.runtime.TokenStream.getText.

Return the text of all tokens within the specified interval. This method behaves like the following code (including potential exceptions for violating preconditions of get, but may be optimized by the specific implementation.

TokenStream stream = ...;
String text = "";
for (int i = interval.a; i <= interval.b; i++) {
  text += stream.get(i).getText();
}

Parameters

interval:Interval

The interval of tokens within this stream to get text for.

Returns:String

The text of all tokens within the specified interval in this stream.

Annotations

@NotNull

@Override

Implements org.antlr.v4.runtime.TokenStream.getText.

Doc from org.antlr.v4.runtime.TokenStream.getText.

Return the text of all tokens in the source interval of the specified context. This method behaves like the following code, including potential exceptions from the call to getText(Interval), but may be optimized by the specific implementation.

If ctx.getSourceInterval() does not return a valid interval of tokens provided by this stream, the behavior is unspecified.

TokenStream stream = ...;
String text = stream.getText(ctx.getSourceInterval());

Parameters

ctx:RuleContext

The context providing the source interval of tokens to get text for.

Returns:String

The text of all tokens within the source interval of ctx.

Annotations

@NotNull

@Override

Implements org.antlr.v4.runtime.TokenStream.getText.

Doc from org.antlr.v4.runtime.TokenStream.getText.

Return the text of all tokens in this stream between start and stop (inclusive).

If the specified start or stop token was not provided by this stream, or if the stop occurred before the start token, the behavior is unspecified.

For streams which ensure that the Token#getTokenIndex method is accurate for all of its provided tokens, this method behaves like the following code. Other streams may implement this method in other ways provided the behavior is consistent with this at a high level.

TokenStream stream = ...;
String text = "";
for (int i = start.getTokenIndex(); i <= stop.getTokenIndex(); i++) {
  text += stream.get(i).getText();
}

Parameters

start:Object

The first token in the interval to get text for.

stop:Object

The last token in the interval to get text for (inclusive).

Returns:String

The text of all tokens lying between the specified start and stop tokens.

Annotations

@NotNull

@Override

Given a start and stop index, return a List of all tokens in the token type BitSet. Return null if no tokens were found. This method looks at both on and off channel tokens.

Implements org.antlr.v4.runtime.TokenStream.getTokenSource.

Doc from org.antlr.v4.runtime.TokenStream.getTokenSource.

Gets the underlying TokenSource which provides tokens for this stream.

Annotations

@Override

Implements org.antlr.v4.runtime.IntStream.index.

Doc from org.antlr.v4.runtime.IntStream.index.

Return the index into the stream of the input symbol referred to by LA(1).

The behavior of this method is unspecified if no call to an initializing method has occurred after this stream was constructed.

Annotations

@Override

Implements org.antlr.v4.runtime.IntStream.LA.

Doc from org.antlr.v4.runtime.IntStream.LA.

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

Annotations

@Override

Implements org.antlr.v4.runtime.TokenStream.LT.

Doc from org.antlr.v4.runtime.TokenStream.LT.

Get the Token instance associated with the value returned by LA(k). This method has the same pre- and post-conditions as IntStream#LA. In addition, when the preconditions of this method are met, the return value is non-null and the value of LT(k).getType()==LA(k).

Annotations

@NotNull

@Override

Implements org.antlr.v4.runtime.IntStream.mark.

Doc from org.antlr.v4.runtime.IntStream.mark.

A mark provides a guarantee that seek() operations will be valid over a "marked range" extending from the index where mark() was called to the current index(). This allows the use of streaming input sources by specifying the minimum buffering requirements to support arbitrary lookahead during prediction.

The returned mark is an opaque handle (type int) which is passed to release() when the guarantees provided by the marked range are no longer necessary. When calls to mark()/release() are nested, the marks must be released in reverse order of which they were obtained. Since marked regions are used during performance-critical sections of prediction, the specific behavior of invalid usage is unspecified (i.e. a mark is not released, or a mark is released twice, or marks are not released in reverse order from which they were created).

The behavior of this method is unspecified if no call to an initializing method has occurred after this stream was constructed.

This method does not change the current position in the input stream.

The following example shows the use of mark(), release(mark), index(), and seek(index) as part of an operation to safely work within a marked region, then restore the stream position to its original value and release the mark.

IntStream stream = ...;
int index = -1;
int mark = stream.mark();
try {
  index = stream.index();
  // perform work here...
} finally {
  if (index != -1) {
    stream.seek(index);
  }
  stream.release(mark);
}

Returns:int

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

Annotations

@Override

Implements org.antlr.v4.runtime.IntStream.release.

Doc from org.antlr.v4.runtime.IntStream.release.

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 mark.

Parameters

marker:int

A marker returned by a call to mark().

Annotations

@Override

This method resets the token stream back to the first token in the buffer. It is equivalent to calling seek(0).

Annotations

@Deprecated

See Also

setTokenSource(TokenSource)

Implements org.antlr.v4.runtime.IntStream.seek.

Doc from org.antlr.v4.runtime.IntStream.seek.

Set the input cursor to the position indicated by index. If the specified index lies past the end of the stream, the operation behaves as though index was the index of the EOF symbol. After this method returns without throwing an exception, then at least one of the following will be true.

• index() will return the index of the first symbol appearing at or after the specified index. Specifically, implementations which filter their sources should automatically adjust index forward the minimum amount required for the operation to target a non-ignored symbol.
• LA(1) returns EOF

Parameters

index:int

The absolute index to seek to.

Annotations

@Override

Reset this token stream by setting its token source.

Implements org.antlr.v4.runtime.IntStream.size.

Doc from org.antlr.v4.runtime.IntStream.size.

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

Annotations

@Override