src/org/mozilla/javascript/WrappedException.java

   1 /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-\r
   2  *\r
   3  * The contents of this file are subject to the Netscape Public\r
   4  * License Version 1.1 (the "License"); you may not use this file\r
   5  * except in compliance with the License. You may obtain a copy of\r
   6  * the License at http://www.mozilla.org/NPL/\r
   7  *\r
   8  * Software distributed under the License is distributed on an "AS\r
   9  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr\r
  10  * implied. See the License for the specific language governing\r
  11  * rights and limitations under the License.\r
  12  *\r
  13  * The Original Code is Rhino code, released\r
  14  * May 6, 1999.\r
  15  *\r
  16  * The Initial Developer of the Original Code is Netscape\r
  17  * Communications Corporation.  Portions created by Netscape are\r
  18  * Copyright (C) 1997-1999 Netscape Communications Corporation. All\r
  19  * Rights Reserved.\r
  20  *\r
  21  * Contributor(s): \r
  22  * Norris Boyd\r
  23  *\r
  24  * Alternatively, the contents of this file may be used under the\r
  25  * terms of the GNU Public License (the "GPL"), in which case the\r
  26  * provisions of the GPL are applicable instead of those above.\r
  27  * If you wish to allow use of your version of this file only\r
  28  * under the terms of the GPL and not to allow others to use your\r
  29  * version of this file under the NPL, indicate your decision by\r
  30  * deleting the provisions above and replace them with the notice\r
  31  * and other provisions required by the GPL.  If you do not delete\r
  32  * the provisions above, a recipient may use your version of this\r
  33  * file under either the NPL or the GPL.\r
  34  */\r
  35 \r
  36 package org.mozilla.javascript;\r
  37 import java.lang.reflect.InvocationTargetException;\r
  38 \r
  39 /**\r
  40  * A wrapper for runtime exceptions.\r
  41  *\r
  42  * Used by the JavaScript runtime to wrap and propagate exceptions that occur\r
  43  * during runtime.\r
  44  *\r
  45  * @author Norris Boyd\r
  46  */\r
  47 public class WrappedException extends EvaluatorException implements Wrapper {\r
  48 \r
  49     /**\r
  50      * Create a new exception wrapped around an existing exception.\r
  51      *\r
  52      * @param exception the exception to wrap\r
  53      */\r
  54     public WrappedException(Throwable exception) {\r
  55         super(exception.getMessage());\r
  56         this.exception = exception.fillInStackTrace();\r
  57     }\r
  58 \r
  59     /**\r
  60      * Get the message for the exception.\r
  61      *\r
  62      * Delegates to the wrapped exception.\r
  63      */\r
  64     public String getMessage() {\r
  65         return "WrappedException of " + exception.toString();\r
  66     }\r
  67 \r
  68     /**\r
  69      * Gets the localized message.\r
  70      *\r
  71      * Delegates to the wrapped exception.\r
  72      */\r
  73     public String getLocalizedMessage() {\r
  74         return "WrappedException of " + exception.getLocalizedMessage();\r
  75     }\r
  76 \r
  77     /**\r
  78      * Get the wrapped exception.\r
  79      *\r
  80      * @return the exception that was presented as a argument to the\r
  81      *         constructor when this object was created\r
  82      */\r
  83     public Throwable getWrappedException() {\r
  84         return exception;\r
  85     }\r
  86 \r
  87     /**\r
  88      * Get the wrapped exception.\r
  89      *\r
  90      * @return the exception that was presented as a argument to the\r
  91      *         constructor when this object was created\r
  92      */\r
  93     public Object unwrap() {\r
  94         return exception;\r
  95     }\r
  96 \r
  97     /**\r
  98      * Wrap an exception.\r
  99      *\r
 100      * Provides special cases for EvaluatorExceptions (which are returned\r
 101      * as-is), and InvocationTargetExceptions (which are unwrapped and\r
 102      * passed to a recursive call to wrapException).<p>\r
 103      *\r
 104      * Otherwise the exception is simply wrapped in a WrappedException.\r
 105      */\r
 106     public static EvaluatorException wrapException(Throwable e) {\r
 107         if ((e instanceof InvocationTargetException))\r
 108             e = ((InvocationTargetException) e).getTargetException();\r
 109         if (e instanceof EvaluatorException)\r
 110             return (EvaluatorException) e;\r
 111         return new WrappedException(e);\r
 112     }\r
 113 \r
 114     private Throwable exception;\r
 115 }\r