libjava/classpath/javax/management/RuntimeErrorException.java

   1 /* RuntimeErrorException.java -- A user-defined management error.
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.management;
  39
  40 /**
  41  * Represents an arbitrary error thrown by a management
  42  * bean.  When a management bean executes code that causes
  43  * an error to be thrown, the resulting error is
  44  * wrapped inside an {@link RuntimeErrorException}.  Calling
  45  * {@link getTargetError()} will return the wrapped
  46  * exception.
  47  *
  48  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  49  * @since 1.5
  50  */
  51 public class RuntimeErrorException
  52   extends JMRuntimeException
  53 {
  54
  55   /**
  56    * Compatible with JDK 1.5
  57    */
  58   private static final long serialVersionUID = 704338937753949796L;
  59
  60   /**
  61    * The target error.
  62    *
  63    * @serial the target error.
  64    */
  65   private Error error;
  66
  67   /**
  68    * Constructs a new <code>RuntimeErrorException</code> wrapping
  69    * the specified error.
  70    *
  71    * @param e the error to be wrapped.
  72    */
  73   public RuntimeErrorException(Error e)
  74   {
  75     super();
  76     error = e;
  77   }
  78
  79   /**
  80    * Constructs a new <code>RuntimeErrorException</code> wrapping
  81    * the specified error and using the supplied message.
  82    *
  83    * @param e the error to be wrapped.
  84    * @param message the error message to give to the user.
  85    */
  86   public RuntimeErrorException(Error e, String message)
  87   {
  88     super(message);
  89     error = e;
  90   }
  91
  92   /**
  93    * Returns the true cause of this error, the wrapped
  94    * error.
  95    *
  96    * @return the wrapped error.
  97    */
  98   public Throwable getCause()
  99   {
 100     return error;
 101   }
 102
 103   /**
 104    * Returns the true cause of this error, the wrapped
 105    * error.
 106    *
 107    * @return the wrapped error.
 108    */
 109   public Error getTargetError()
 110   {
 111     return error;
 112   }
 113
 114 }