01: /*****************************************************************************
02: * *
03: * This file is part of the BeanShell Java Scripting distribution. *
04: * Documentation and updates may be found at http://www.beanshell.org/ *
05: * *
06: * Sun Public License Notice: *
07: * *
08: * The contents of this file are subject to the Sun Public License Version *
09: * 1.0 (the "License"); you may not use this file except in compliance with *
10: * the License. A copy of the License is available at http://www.sun.com *
11: * *
12: * The Original Code is BeanShell. The Initial Developer of the Original *
13: * Code is Pat Niemeyer. Portions created by Pat Niemeyer are Copyright *
14: * (C) 2000. All Rights Reserved. *
15: * *
16: * GNU Public License Notice: *
17: * *
18: * Alternatively, the contents of this file may be used under the terms of *
19: * the GNU Lesser General Public License (the "LGPL"), in which case the *
20: * provisions of LGPL are applicable instead of those above. If you wish to *
21: * allow use of your version of this file only under the terms of the LGPL *
22: * and not to allow others to use your version of this file under the SPL, *
23: * indicate your decision by deleting the provisions above and replace *
24: * them with the notice and other provisions required by the LGPL. If you *
25: * do not delete the provisions above, a recipient may use your version of *
26: * this file under either the SPL or the LGPL. *
27: * *
28: * Patrick Niemeyer (pat@pat.net) *
29: * Author of Learning Java, O'Reilly & Associates *
30: * http://www.pat.net/~pat/ *
31: * *
32: *****************************************************************************/package org.gjt.sp.jedit.bsh;
33:
34: /**
35: UtilEvalError is an error corresponding to an EvalError but thrown by a
36: utility or other class that does not have the caller context (Node)
37: available to it. A normal EvalError must supply the caller Node in order
38: for error messages to be pinned to the correct line and location in the
39: script. UtilEvalError is a checked exception that is *not* a subtype of
40: EvalError, but instead must be caught and rethrown as an EvalError by
41: the a nearest location with context. The method toEvalError( Node )
42: should be used to throw the EvalError, supplying the node.
43: <p>
44:
45: To summarize: Utilities throw UtilEvalError. ASTs throw EvalError.
46: ASTs catch UtilEvalError and rethrow it as EvalError using
47: toEvalError( Node ).
48: <p>
49:
50: Philosophically, EvalError and UtilEvalError corrospond to
51: RuntimeException. However they are constrained in this way in order to
52: add the context for error reporting.
53:
54: @see UtilTargetError
55: */
56: public class UtilEvalError extends Exception {
57: protected UtilEvalError() {
58: }
59:
60: public UtilEvalError(String s) {
61: super (s);
62: }
63:
64: /**
65: Re-throw as an eval error, prefixing msg to the message and specifying
66: the node. If a node already exists the addNode is ignored.
67: @see #setNode( org.gjt.sp.jedit.bsh.SimpleNode )
68: <p>
69: @param msg may be null for no additional message.
70: */
71: public EvalError toEvalError(String msg, SimpleNode node,
72: CallStack callstack) {
73: if (Interpreter.DEBUG)
74: printStackTrace();
75:
76: if (msg == null)
77: msg = "";
78: else
79: msg = msg + ": ";
80: return new EvalError(msg + getMessage(), node, callstack);
81: }
82:
83: public EvalError toEvalError(SimpleNode node, CallStack callstack) {
84: return toEvalError(null, node, callstack);
85: }
86:
87: }
|