Top Description Fields Constructors Methods
org.antlr.runtime

public Class RecognitionException

extends Exception
Class Inheritance
Known Direct Subclasses
org.antlr.runtime.EarlyExitException, org.antlr.runtime.FailedPredicateException, org.antlr.runtime.MismatchedRangeException, org.antlr.runtime.MismatchedSetException, org.antlr.runtime.MismatchedTokenException, org.antlr.runtime.MismatchedTreeNodeException, org.antlr.runtime.NoViableAltException
Imports
org.antlr.runtime.tree.*

The root of the ANTLR exception hierarchy. To avoid English-only error messages and to generally make things as flexible as possible, these exceptions are not created with strings, but rather the information necessary to generate an error. Then the various reporting methods in Parser and Lexer can be overridden to generate a localized error message. For example, MismatchedToken exceptions are built with the expected token type. So, don't expect getMessage() to return anything. Note that as of Java 1.4, you can access the stack trace, which means that you can compute the complete trace of rules from the start symbol. This gives you considerable context information with which to generate useful error messages. ANTLR generates code that throws exceptions upon recognition error and also generates code to catch these exceptions in each rule. If you want to quit upon first error, you can turn off the automatic error handling mechanism using rulecatch action, but you still need to override methods mismatch and recoverFromMismatchSet. In general, the recognition exceptions can track where in a grammar a problem occurred and/or what was the expected input. While the parser knows its state (such as current input symbol and line info) that state can change before the exception is reported so current token index is computed and stored at exception time. From this info, you can perhaps print an entire line of input not just a single token, for example. Better to just say the recognizer had a problem and then let the parser figure out a fancy report.

Field Summary

Modifier and TypeField and Description
public boolean
approximateLineInfo

If you are parsing a tree node stream, you will encounter som imaginary nodes w/o line/col info.

public int
c

The current char when an error occurred.

public int
public int
index

What is index of token/char were we looking at when the error occurred?

public transient IntStream
input

What input stream did the error occur in?

public int
line

Track the line at which the error occurred in case this is generated from a lexer.

public Object
node

If this is a tree parser exception, node is set to the node with the problem.

public Token
token

The current Token when an error occurred.

Constructor Summary

AccessConstructor and Description
public
RecognitionException()

Used for remote debugger deserialization

public

Method Summary

Modifier and TypeMethod and Description
protected void
public int
getUnexpectedType()

Return the token type or char of the unexpected input element

Field Detail

approximateLineInfoback to summary
public boolean approximateLineInfo

If you are parsing a tree node stream, you will encounter som imaginary nodes w/o line/col info. We now search backwards looking for most recent token with line/col info, but notify getErrorHeader() that info is approximate.

cback to summary
public int c

The current char when an error occurred. For lexers.

charPositionInLineback to summary
public int charPositionInLine
indexback to summary
public int index

What is index of token/char were we looking at when the error occurred?

inputback to summary
public transient IntStream input

What input stream did the error occur in?

lineback to summary
public int line

Track the line at which the error occurred in case this is generated from a lexer. We need to track this since the unexpected char doesn't carry the line info.

nodeback to summary
public Object node

If this is a tree parser exception, node is set to the node with the problem.

tokenback to summary
public Token token

The current Token when an error occurred. Since not all streams can retrieve the ith Token, we have to track the Token object. For parsers. Even when it's a tree parser, token might be set.

Constructor Detail

RecognitionExceptionback to summary
public RecognitionException()

Used for remote debugger deserialization

RecognitionExceptionback to summary
public RecognitionException(IntStream input)

Method Detail

extractInformationFromTreeNodeStreamback to summary
protected void extractInformationFromTreeNodeStream(IntStream input)
getUnexpectedTypeback to summary
public int getUnexpectedType()

Return the token type or char of the unexpected input element