Java.target.apidocs.org.antlr.v4.runtime.package-summary.html Maven / Gradle / Ivy

Go to download







org.antlr.v4.runtime (ANTLR 4 Runtime (Optimized) 4.7.1 API)













Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Package
Next Package


Frames
No Frames


All Classes









Package org.antlr.v4.runtime





Interface Summary 

Interface
Description



ANTLRErrorListener<Symbol>

How to emit recognition errors.



ANTLRErrorStrategy

The interface for defining strategies to deal with syntax errors encountered
 during a parse by ANTLR-generated parsers.



CharStream

A source of characters for an ANTLR lexer.



IntStream

A simple stream of symbols whose values are represented as integers.



ParserErrorListener

How to emit recognition errors for parsers.



Token

A token has properties: text, type, line, character position in the line
  (so we can ignore tabs), token channel, index, and source from which
  we obtained this token.



TokenFactory

The default mechanism for creating tokens.



TokenSource

A source of tokens must provide a sequence of tokens via TokenSource.nextToken()
 and also must reveal it's source of characters; CommonToken's text is
 computed from a CharStream; it only store indices into the char
 stream.



TokenStream

An IntStream whose symbols are Token instances.



UnicodeCharStream
 


Vocabulary

This interface provides information about the vocabulary used by a
 recognizer.



WritableToken
 






Class Summary 

Class
Description



ANTLRFileStream
Deprecated
as of 4.7 Please use CharStreams interface.



ANTLRInputStream
Deprecated
as of 4.7 Please use CharStreams interface.



BailErrorStrategy

This implementation of ANTLRErrorStrategy responds to syntax errors
 by immediately canceling the parse operation with a
 ParseCancellationException.



BaseErrorListener

Provides an empty default implementation of ANTLRErrorListener.



BufferedTokenStream

This implementation of TokenStream loads tokens from a
 TokenSource on-demand, and places the tokens in a buffer to provide
 access to any previous token by index.



CodePointBuffer

Wrapper for ByteBuffer / CharBuffer / IntBuffer.



CodePointBuffer.Builder
 


CodePointCharStream

Alternative to ANTLRInputStream which treats the input
 as a series of Unicode code points, instead of a series of UTF-16
 code units.



CommonToken
 


CommonTokenFactory

This default implementation of TokenFactory creates
 CommonToken objects.



CommonTokenStream

This class extends BufferedTokenStream with functionality to filter
 token streams to tokens on a particular channel (tokens where
 Token.getChannel() returns a particular value).



ConsoleErrorListener
 


DefaultErrorStrategy

This is the default implementation of ANTLRErrorStrategy used for
 error reporting and recovery in ANTLR parsers.



DiagnosticErrorListener

This implementation of ANTLRErrorListener can be used to identify
 certain potential correctness and performance problems in grammars.



InterpreterRuleContext

This class extends ParserRuleContext by allowing the value of
 InterpreterRuleContext.getRuleIndex() to be explicitly set for the context.



Lexer

A lexer is recognizer that draws input symbols from a character stream.



LexerInterpreter
 


ListTokenSource

Provides an implementation of TokenSource as a wrapper around a list
 of Token objects.



Parser

This is all the parsing support code essentially; most of it is error recovery stuff.



Parser.TrimToSizeListener
 


ParserInterpreter

A parser simulator that mimics what ANTLR's generated
  parser code does.



ParserRuleContext

A rule invocation record for parsing.



ProxyErrorListener<Symbol>

This implementation of ANTLRErrorListener dispatches all calls to a
 collection of delegate listeners.



ProxyParserErrorListener
 


Recognizer<Symbol,ATNInterpreter extends ATNSimulator>
 


RuleContext

A rule context is a record of a single rule invocation.



RuleContextWithAltNum

A handy class for use with

  options {contextSuperClass=org.antlr.v4.runtime.RuleContextWithAltNum;}

  that provides a backing field / impl for the outer alternative number
  matched for an internal parse tree node.



TokenStreamRewriter

Useful for rewriting out a buffered input token stream after doing some
 augmentation or other manipulations on it.



TokenStreamRewriter.RewriteOperation
 


UnbufferedCharStream

Do not buffer up the entire char stream.



UnbufferedTokenStream
 


VocabularyImpl

This class provides a default implementation of the Vocabulary
 interface.







Enum Summary 

Enum
Description



CharStreams

This class represents the primary interface for creating CharStreams
  from a variety of sources as of 4.7.



CodePointBuffer.Type
 


Dependents
 






Exception Summary 

Exception
Description



FailedPredicateException

A semantic predicate failed during validation.



InputMismatchException

This signifies any kind of mismatched input exceptions such as
  when the current input does not match the expected token.



LexerNoViableAltException
 


NoViableAltException

Indicates that the parser could not decide which of two or more paths
  to take based upon the remaining input.



RecognitionException

The root of the ANTLR exception hierarchy.







Annotation Types Summary 

Annotation Type
Description



RuleDependencies

This annotation allows multiple RuleDependency annotations to be
 applied to a single element.



RuleDependency

Declares a dependency upon a grammar rule, along with a set of zero or more
 dependent rules.



RuleVersion
 













Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Package
Next Package


Frames
No Frames


All Classes








Copyright © 1992–2018 Tunnel Vision Laboratories, LLC. All rights reserved.

Interface	Description
ANTLRErrorListener<Symbol>	How to emit recognition errors.
ANTLRErrorStrategy	The interface for defining strategies to deal with syntax errors encountered during a parse by ANTLR-generated parsers.
CharStream	A source of characters for an ANTLR lexer.
IntStream	A simple stream of symbols whose values are represented as integers.
ParserErrorListener	How to emit recognition errors for parsers.
Token	A token has properties: text, type, line, character position in the line (so we can ignore tabs), token channel, index, and source from which we obtained this token.
TokenFactory	The default mechanism for creating tokens.
TokenSource	A source of tokens must provide a sequence of tokens via `TokenSource.nextToken()` and also must reveal it's source of characters; `CommonToken`'s text is computed from a `CharStream`; it only store indices into the char stream.
TokenStream	An `IntStream` whose symbols are `Token` instances.
UnicodeCharStream
Vocabulary	This interface provides information about the vocabulary used by a recognizer.
WritableToken

Class	Description
ANTLRFileStream	Deprecated as of 4.7 Please use `CharStreams` interface.
ANTLRInputStream	Deprecated as of 4.7 Please use `CharStreams` interface.
BailErrorStrategy	This implementation of `ANTLRErrorStrategy` responds to syntax errors by immediately canceling the parse operation with a `ParseCancellationException`.
BaseErrorListener	Provides an empty default implementation of `ANTLRErrorListener`.
BufferedTokenStream	This implementation of `TokenStream` loads tokens from a `TokenSource` on-demand, and places the tokens in a buffer to provide access to any previous token by index.
CodePointBuffer	Wrapper for `ByteBuffer` / `CharBuffer` / `IntBuffer`.
CodePointBuffer.Builder
CodePointCharStream	Alternative to `ANTLRInputStream` which treats the input as a series of Unicode code points, instead of a series of UTF-16 code units.
CommonToken
CommonTokenFactory	This default implementation of `TokenFactory` creates `CommonToken` objects.
CommonTokenStream	This class extends `BufferedTokenStream` with functionality to filter token streams to tokens on a particular channel (tokens where `Token.getChannel()` returns a particular value).
ConsoleErrorListener
DefaultErrorStrategy	This is the default implementation of `ANTLRErrorStrategy` used for error reporting and recovery in ANTLR parsers.
DiagnosticErrorListener	This implementation of `ANTLRErrorListener` can be used to identify certain potential correctness and performance problems in grammars.
InterpreterRuleContext	This class extends `ParserRuleContext` by allowing the value of `InterpreterRuleContext.getRuleIndex()` to be explicitly set for the context.
Lexer	A lexer is recognizer that draws input symbols from a character stream.
LexerInterpreter
ListTokenSource	Provides an implementation of `TokenSource` as a wrapper around a list of `Token` objects.
Parser	This is all the parsing support code essentially; most of it is error recovery stuff.
Parser.TrimToSizeListener
ParserInterpreter	A parser simulator that mimics what ANTLR's generated parser code does.
ParserRuleContext	A rule invocation record for parsing.
ProxyErrorListener<Symbol>	This implementation of `ANTLRErrorListener` dispatches all calls to a collection of delegate listeners.
ProxyParserErrorListener
Recognizer<Symbol,ATNInterpreter extends ATNSimulator>
RuleContext	A rule context is a record of a single rule invocation.
RuleContextWithAltNum	A handy class for use with options {contextSuperClass=org.antlr.v4.runtime.RuleContextWithAltNum;} that provides a backing field / impl for the outer alternative number matched for an internal parse tree node.
TokenStreamRewriter	Useful for rewriting out a buffered input token stream after doing some augmentation or other manipulations on it.
TokenStreamRewriter.RewriteOperation
UnbufferedCharStream	Do not buffer up the entire char stream.
UnbufferedTokenStream
VocabularyImpl	This class provides a default implementation of the `Vocabulary` interface.

Enum	Description
CharStreams	This class represents the primary interface for creating `CharStream`s from a variety of sources as of 4.7.
CodePointBuffer.Type
Dependents

Exception	Description
FailedPredicateException	A semantic predicate failed during validation.
InputMismatchException	This signifies any kind of mismatched input exceptions such as when the current input does not match the expected token.
LexerNoViableAltException
NoViableAltException	Indicates that the parser could not decide which of two or more paths to take based upon the remaining input.
RecognitionException	The root of the ANTLR exception hierarchy.

Annotation Type	Description
RuleDependencies	This annotation allows multiple `RuleDependency` annotations to be applied to a single element.
RuleDependency	Declares a dependency upon a grammar rule, along with a set of zero or more dependent rules.
RuleVersion