org.antlr.tool

Class ToolMessage

java.lang.Object

org.antlr.tool.Message

org.antlr.tool.ToolMessage

public class ToolMessage
extends Message

A generic message from the tool such as "file not found" type errors; there is no reason to create a special object for each error unlike the grammar errors, which may be rather complex. Sometimes you need to pass in a filename or something to say it is "bad". Allow a generic object to be passed in and the string template can deal with just printing it or pulling a property out of it. TODO what to do with exceptions? Want stack trace for internal errors?

Field Summary

Fields inherited from class org.antlr.tool.Message

arg, arg2, column, e, file, line, locationST, messageFormatST, msgID, msgST, reportST

Constructor Summary

Constructors

Constructor and Description
ToolMessage(int msgID)
ToolMessage(int msgID, java.lang.Object arg)
ToolMessage(int msgID, java.lang.Object arg, java.lang.Object arg2)
ToolMessage(int msgID, java.lang.Object arg, java.lang.Throwable e)
ToolMessage(int msgID, java.lang.Throwable e)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class org.antlr.tool.Message

getLocationTemplate, getMessageTemplate, setColumn, setLine, setMessageID, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolMessage

public ToolMessage(int msgID)

ToolMessage

public ToolMessage(int msgID,
           java.lang.Object arg)

ToolMessage

public ToolMessage(int msgID,
           java.lang.Throwable e)

ToolMessage

public ToolMessage(int msgID,
           java.lang.Object arg,
           java.lang.Object arg2)

ToolMessage

public ToolMessage(int msgID,
           java.lang.Object arg,
           java.lang.Throwable e)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object