Top Fields Constructors Methods

org.antlr.v4.tool

public Class ANTLRMessage

Class Inheritance

extends Object

java.lang.Object
org.antlr.v4.tool.ANTLRMessage

Known Direct Subclasses

org.antlr.v4.tool.GrammarSemanticsMessage, org.antlr.v4.tool.GrammarSyntaxMessage, org.antlr.v4.tool.LeftRecursionCyclesMessage, org.antlr.v4.tool.ToolMessage

Imports

org.antlr.runtime.Token, org.stringtemplate.v4.ST, java.util.Arrays

Field Summary

Modifier and Type	Field and Description
private final Object[]	args
public int	charPosition
private final Throwable	e
private static final Object[]	EMPTY_ARGS
private final ErrorType	errorType
public String	fileName
public Grammar	g
public int	line
public Token	offendingToken Most of the time, we'll have a token such as an undefined rule ref and so this will be set.

Constructor Summary

Access	Constructor and Description
public	ANTLRMessage(ErrorType errorType)
public	ANTLRMessage(ErrorType errorType, Token offendingToken, Object... args)
public	ANTLRMessage(ErrorType errorType, Throwable e, Token offendingToken, Object... args)

Method Summary

Modifier and Type	Method and Description
public Object[]	getArgs()
public Throwable	getCause()
public ErrorType	getErrorType()
public ST	getMessageTemplate(boolean verbose)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

args	back to summary
private final Object[] args

charPosition	back to summary
public int charPosition

e	back to summary
private final Throwable e

EMPTY_ARGS	back to summary
private static final Object[] EMPTY_ARGS

errorType	back to summary
private final ErrorType errorType

fileName	back to summary
public String fileName

g	back to summary
public Grammar g

line	back to summary
public int line

offendingToken	back to summary
public Token offendingToken Most of the time, we'll have a token such as an undefined rule ref and so this will be set.

Constructor Detail

ANTLRMessage	back to summary
public ANTLRMessage(ErrorType errorType)

ANTLRMessage	back to summary
public ANTLRMessage(ErrorType errorType, Token offendingToken, Object... args)

ANTLRMessage	back to summary
public ANTLRMessage(ErrorType errorType, Throwable e, Token offendingToken, Object... args)

Method Detail

getArgs	back to summary
public Object[] getArgs()

getCause	back to summary
public Throwable getCause()

getErrorType	back to summary
public ErrorType getErrorType()

getMessageTemplate	back to summary
public ST getMessageTemplate(boolean verbose)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override