01: /*
02: [The "BSD licence"]
03: Copyright (c) 2005-2006 Terence Parr
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09: 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: */
28: package org.antlr.tool;
29:
30: import org.antlr.stringtemplate.StringTemplate;
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: */
42: public class ToolMessage extends Message {
43:
44: public ToolMessage(int msgID) {
45: super (msgID, null, null);
46: }
47:
48: public ToolMessage(int msgID, Object arg) {
49: super (msgID, arg, null);
50: }
51:
52: public ToolMessage(int msgID, Throwable e) {
53: super (msgID);
54: this .e = e;
55: }
56:
57: public ToolMessage(int msgID, Object arg, Object arg2) {
58: super (msgID, arg, arg2);
59: }
60:
61: public ToolMessage(int msgID, Object arg, Throwable e) {
62: super (msgID, arg, null);
63: this .e = e;
64: }
65:
66: public String toString() {
67: StringTemplate st = getMessageTemplate();
68: if (arg != null) {
69: st.setAttribute("arg", arg);
70: }
71: if (arg2 != null) {
72: st.setAttribute("arg2", arg2);
73: }
74: if (e != null) {
75: st.setAttribute("exception", e);
76: st.setAttribute("stackTrace", e.getStackTrace());
77: }
78: return super.toString(st);
79: }
80: }
|