1/* 2 * [The "BSD license"] 3 * Copyright (c) 2010 Terence Parr 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28package org.antlr.tool; 29 30import org.stringtemplate.v4.ST; 31 32/** A generic message from the tool such as "file not found" type errors; there 33 * is no reason to create a special object for each error unlike the grammar 34 * errors, which may be rather complex. 35 * 36 * Sometimes you need to pass in a filename or something to say it is "bad". 37 * Allow a generic object to be passed in and the string template can deal 38 * with just printing it or pulling a property out of it. 39 * 40 * TODO what to do with exceptions? Want stack trace for internal errors? 41 */ 42public class ToolMessage extends Message { 43 44 public ToolMessage(int msgID) { 45 super(msgID, null, null); 46 } 47 public ToolMessage(int msgID, Object arg) { 48 super(msgID, arg, null); 49 } 50 public ToolMessage(int msgID, Throwable e) { 51 super(msgID); 52 this.e = e; 53 } 54 public ToolMessage(int msgID, Object arg, Object arg2) { 55 super(msgID, arg, arg2); 56 } 57 public ToolMessage(int msgID, Object arg, Throwable e) { 58 super(msgID,arg,null); 59 this.e = e; 60 } 61 public String toString() { 62 ST st = getMessageTemplate(); 63 if ( arg!=null ) { 64 st.add("arg", arg); 65 } 66 if ( arg2!=null ) { 67 st.add("arg2", arg2); 68 } 69 if ( e!=null ) { 70 st.add("exception", e); 71 st.add("stackTrace", e.getStackTrace()); 72 } 73 return super.toString(st); 74 } 75} 76