Top Description Fields Constructors Methods
org.antlr.tool

public abstract Class Message

extends Object
Class Inheritance
Known Direct Subclasses
org.antlr.tool.NonRegularDecisionMessage, org.antlr.tool.RecursionOverflowMessage, org.antlr.tool.ToolMessage, org.antlr.tool.GrammarAnalysisAbortedMessage, org.antlr.tool.GrammarDanglingStateMessage, org.antlr.tool.GrammarInsufficientPredicatesMessage, org.antlr.tool.GrammarNonDeterminismMessage, org.antlr.tool.GrammarSemanticsMessage, org.antlr.tool.GrammarSyntaxMessage, org.antlr.tool.GrammarUnreachableAltsMessage, org.antlr.tool.LeftRecursionCyclesMessage
Imports
org.stringtemplate.v4.ST
The ANTLR code calls methods on ErrorManager to report errors etc... Rather than simply pass these arguments to the ANTLRErrorListener directly, create an object that encapsulates everything. In this way, the error listener interface does not have to change when I add a new kind of error message. I don't want to break a GUI for example every time I update the error system in ANTLR itself. To get a printable error/warning message, call toString().

Field Summary

Modifier and TypeField and Description
public Object
arg

public Object
arg2

public int
column

public Throwable
e

public String
file

public int
line

public ST
locationST

public ST
messageFormatST

public int
msgID

public ST
msgST

public ST
reportST

Constructor Summary

AccessConstructor and Description
public
Message()

public
Message(int msgID)

public
Message(int msgID, Object arg, Object arg2)

Method Summary

Modifier and TypeMethod and Description
public ST
getLocationTemplate()

Return a new template instance for the location part of a Message.

public ST
getMessageTemplate()

Return a new template instance every time someone tries to print a Message.

public void
setColumn(int column)

public void
setLine(int line)

public void
setMessageID(int msgID)

public String
toString(ST messageST)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

argback to summary
public Object arg
arg2back to summary
public Object arg2
columnback to summary
public int column
eback to summary
public Throwable e
fileback to summary
public String file
lineback to summary
public int line
locationSTback to summary
public ST locationST
messageFormatSTback to summary
public ST messageFormatST
msgIDback to summary
public int msgID
msgSTback to summary
public ST msgST
reportSTback to summary
public ST reportST

Constructor Detail

Messageback to summary
public Message()
Messageback to summary
public Message(int msgID)
Messageback to summary
public Message(int msgID, Object arg, Object arg2)

Method Detail

getLocationTemplateback to summary
public ST getLocationTemplate()

Return a new template instance for the location part of a Message.

Todo

Is this really necessary? -Kay

getMessageTemplateback to summary
public ST getMessageTemplate()

Return a new template instance every time someone tries to print a Message.

setColumnback to summary
public void setColumn(int column)
setLineback to summary
public void setLine(int line)
setMessageIDback to summary
public void setMessageID(int msgID)
toStringback to summary
public String toString(ST messageST)