org.antlr.v4.tool

Class ToolMessage

java.lang.Object

org.antlr.v4.tool.ANTLRMessage

org.antlr.v4.tool.ToolMessage

public class ToolMessage
extends ANTLRMessage

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.

Field Summary

Fields inherited from class org.antlr.v4.tool.ANTLRMessage

charPosition, fileName, g, line, offendingToken

Constructor Summary

Constructors

Constructor and Description
ToolMessage(ErrorType errorType)
ToolMessage(ErrorType errorType, Object... args)
ToolMessage(ErrorType errorType, Throwable e, Object... args)

Method Summary

Methods inherited from class org.antlr.v4.tool.ANTLRMessage

getArgs, getCause, getErrorType, getMessageTemplate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolMessage

public ToolMessage(ErrorType errorType)

ToolMessage

public ToolMessage(ErrorType errorType,
           Object... args)

ToolMessage

public ToolMessage(ErrorType errorType,
           Throwable e,
           Object... args)