ANTLR 4 Runtime (Optimized) 4.9.0 · org.antlr.v4.runtime.ANTLRErrorStrategy

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the parser is currently recovering from a parse error, otherwise `false` inErrorRecoveryMode(Parser the parser instance recognizer) Tests whether or not `recognizer` is in the process of recovering from an error.
public void	recover(Parser the parser instance recognizer, RecognitionException the recognition exception to recover from e) This method is called to recover from exception `e`.
public Token	recoverInline(Parser the parser instance recognizer) This method is called when an unexpected symbol is encountered during an inline match operation, such as `Parser#match`.
public void	reportError(Parser the parser instance recognizer, RecognitionException the recognition exception to report e) Report any kind of `RecognitionException`.
public void	reportMatch(Parser the parser instance recognizer) This method is called by when the parser successfully matches an input symbol.
public void	reset(Parser the parser instance recognizer) Reset the error handler state for the specified `recognizer`.
public void	sync(Parser the parser instance recognizer) This method provides the error handler with an opportunity to handle syntactic or semantic errors in the input stream before they result in a `RecognitionException`.

Method Detail

inErrorRecoveryMode back to summary

inErrorRecoveryMode	back to summary
public boolean inErrorRecoveryMode(Parser recognizer) Tests whether or not `recognizer` is in the process of recovering from an error. In error recovery mode, `Parser#consume` adds symbols to the parse tree by calling `Parser#createErrorNode(ParserRuleContext, Token)` then `ParserRuleContext#addErrorNode(ErrorNode)` instead of `Parser#createTerminalNode(ParserRuleContext, Token)`. Parameters recognizer:Parser the parser instance Returns:boolean `true` if the parser is currently recovering from a parse error, otherwise `false`

public boolean inErrorRecoveryMode(Parser recognizer)

Tests whether or not recognizer is in the process of recovering from an error. In error recovery mode, Parser#consume adds symbols to the parse tree by calling Parser#createErrorNode(ParserRuleContext, Token) then ParserRuleContext#addErrorNode(ErrorNode) instead of Parser#createTerminalNode(ParserRuleContext, Token).

Parameters

recognizer:Parser: the parser instance

Returns:boolean

true if the parser is currently recovering from a parse error, otherwise false

recover back to summary

recover	back to summary
public void recover(Parser recognizer, RecognitionException e) throws RecognitionException This method is called to recover from exception `e`. This method is called after `reportError` by the default exception handler generated for a rule method. Parameters recognizer:Parser the parser instance e:RecognitionException the recognition exception to recover from Exceptions RecognitionException: if the error strategy could not recover from the recognition exception See Also `reportError`

public void recover(Parser recognizer, RecognitionException e) throws RecognitionException

This method is called to recover from exception e. This method is called after reportError by the default exception handler generated for a rule method.

Parameters

recognizer:Parser: the parser instance
e:RecognitionException: the recognition exception to recover from

Exceptions

RecognitionException:: if the error strategy could not recover from the recognition exception

See Also

reportError

recoverInline back to summary

recoverInline	back to summary
public Token recoverInline(Parser recognizer) throws RecognitionException This method is called when an unexpected symbol is encountered during an inline match operation, such as `Parser#match`. If the error strategy successfully recovers from the match failure, this method returns the `Token` instance which should be treated as the successful result of the match. This method handles the consumption of any tokens - the caller should not call `Parser#consume` after a successful recovery. Note that the calling code will not report an error if this method returns successfully. The error strategy implementation is responsible for calling `Parser#notifyErrorListeners` as appropriate. Parameters recognizer:Parser the parser instance Annotations @NotNull Exceptions RecognitionException: if the error strategy was not able to recover from the unexpected input symbol

public Token recoverInline(Parser recognizer) throws RecognitionException

This method is called when an unexpected symbol is encountered during an inline match operation, such as Parser#match. If the error strategy successfully recovers from the match failure, this method returns the Token instance which should be treated as the successful result of the match.

This method handles the consumption of any tokens - the caller should not call Parser#consume after a successful recovery.

Note that the calling code will not report an error if this method returns successfully. The error strategy implementation is responsible for calling Parser#notifyErrorListeners as appropriate.

Parameters

recognizer:Parser: the parser instance

Annotations

@NotNull

Exceptions

RecognitionException:: if the error strategy was not able to recover from the unexpected input symbol

reportError back to summary

reportError	back to summary
public void reportError(Parser recognizer, RecognitionException e) Report any kind of `RecognitionException`. This method is called by the default exception handler generated for a rule method. Parameters recognizer:Parser the parser instance e:RecognitionException the recognition exception to report

public void reportError(Parser recognizer, RecognitionException e)

Report any kind of RecognitionException. This method is called by the default exception handler generated for a rule method.

Parameters

recognizer:Parser: the parser instance
e:RecognitionException: the recognition exception to report

reportMatch	back to summary
public void reportMatch(Parser recognizer) This method is called by when the parser successfully matches an input symbol. Parameters recognizer:Parser the parser instance

reportMatch

back to summary

public void reportMatch(Parser recognizer)

This method is called by when the parser successfully matches an input symbol.

Parameters

recognizer:Parser: the parser instance

reset back to summary

reset	back to summary
public void reset(Parser recognizer) Reset the error handler state for the specified `recognizer`. Parameters recognizer:Parser the parser instance

public void reset(Parser recognizer)

Reset the error handler state for the specified recognizer.

Parameters

recognizer:Parser: the parser instance

sync back to summary

sync	back to summary
public void sync(Parser recognizer) throws RecognitionException This method provides the error handler with an opportunity to handle syntactic or semantic errors in the input stream before they result in a `RecognitionException`. The generated code currently contains calls to `sync` after entering the decision state of a closure block (`(...)*` or `(...)+`). For an implementation based on Jim Idle's "magic sync" mechanism, see `DefaultErrorStrategy#sync`. Parameters recognizer:Parser the parser instance Exceptions RecognitionException: if an error is detected by the error strategy but cannot be automatically recovered at the current state in the parsing process See Also `DefaultErrorStrategy#sync`

public void sync(Parser recognizer) throws RecognitionException

This method provides the error handler with an opportunity to handle syntactic or semantic errors in the input stream before they result in a RecognitionException.

The generated code currently contains calls to sync after entering the decision state of a closure block ((...)* or (...)+).

For an implementation based on Jim Idle's "magic sync" mechanism, see DefaultErrorStrategy#sync.

Parameters

recognizer:Parser: the parser instance

Exceptions

RecognitionException:: if an error is detected by the error strategy but cannot be automatically recovered at the current state in the parsing process

See Also

DefaultErrorStrategy#sync

public Interface ANTLRErrorStrategy

Method Summary

Method Detail