org.antlr.tool
Class Message

java.lang.Object
  org.antlr.tool.Message

Direct Known Subclasses:

GrammarAnalysisAbortedMessage, GrammarDanglingStateMessage, GrammarInsufficientPredicatesMessage, GrammarNonDeterminismMessage, GrammarSemanticsMessage, GrammarSyntaxMessage, GrammarUnreachableAltsMessage, LeftRecursionCyclesMessage, NonRegularDecisionMessage, RecursionOverflowMessage, ToolMessage

public abstract class Message
extends Object

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

Object	arg
Object	arg2
int	column
Throwable	e
String	file
int	line
org.stringtemplate.v4.ST	locationST
org.stringtemplate.v4.ST	messageFormatST
int	msgID
org.stringtemplate.v4.ST	msgST
org.stringtemplate.v4.ST	reportST

Constructor Summary

Message()

Message(int msgID)

Message(int msgID, Object arg, Object arg2)

Method Summary

org.stringtemplate.v4.ST	getLocationTemplate() Return a new template instance for the location part of a Message.
org.stringtemplate.v4.ST	getMessageTemplate() Return a new template instance every time someone tries to print a Message.
void	setColumn(int column)
void	setLine(int line)
void	setMessageID(int msgID)
String	toString(org.stringtemplate.v4.ST messageST)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

msgST

public org.stringtemplate.v4.ST msgST

locationST

public org.stringtemplate.v4.ST locationST

reportST

public org.stringtemplate.v4.ST reportST

messageFormatST

public org.stringtemplate.v4.ST messageFormatST

msgID

public int msgID

arg

public Object arg

arg2

public Object arg2

e

public Throwable e

file

public String file

line

public int line

column

public int column

Constructor Detail

Message

public Message()

Message

public Message(int msgID)

Message

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

Method Detail

setLine

public void setLine(int line)

setColumn

public void setColumn(int column)

setMessageID

public void setMessageID(int msgID)

getMessageTemplate

public org.stringtemplate.v4.ST getMessageTemplate()

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

getLocationTemplate

public org.stringtemplate.v4.ST getLocationTemplate()

Return a new template instance for the location part of a Message. TODO: Is this really necessary? -Kay

toString

public String toString(org.stringtemplate.v4.ST messageST)