libjava/classpath/javax/management/RuntimeMBeanException.java

   1 /* RuntimeMBeanException.java -- A user-defined management exception.
   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 runtime exception thrown by a management
  42  * bean.  When a management bean executes code that causes a runtime
  43  * exception to be thrown, the resulting exception is wrapped inside a
  44  * {@link RuntimeMBeanException}.  Calling {@link
  45  * getTargetException()} will return the wrapped exception.
  46  *
  47  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  48  * @since 1.5
  49  */
  50 public class RuntimeMBeanException
  51   extends JMRuntimeException
  52 {
  53
  54   /**
  55    * Compatible with JDK 1.5
  56    */
  57   private static final long serialVersionUID = 5274912751982730171L;
  58
  59   /**
  60    * The target exception.
  61    *
  62    * @serial the target exception.
  63    */
  64   private RuntimeException runtimeException;
  65
  66   /**
  67    * Constructs a new <code>RuntimeMBeanException</code> wrapping
  68    * the specified exception.
  69    *
  70    * @param e the exception to be wrapped.
  71    */
  72   public RuntimeMBeanException(RuntimeException e)
  73   {
  74     super();
  75     runtimeException = e;
  76   }
  77
  78   /**
  79    * Constructs a new <code>RuntimeMBeanException</code> wrapping
  80    * the specified exception and using the supplied message.
  81    *
  82    * @param e the exception to be wrapped.
  83    * @param message the error message to give to the user.
  84    */
  85   public RuntimeMBeanException(RuntimeException e, String message)
  86   {
  87     super(message);
  88     runtimeException = e;
  89   }
  90
  91   /**
  92    * Returns the true cause of this exception, the wrapped runtime
  93    * exception.
  94    *
  95    * @return the wrapped exception.
  96    */
  97   public Throwable getCause()
  98   {
  99     return runtimeException;
 100   }
 101
 102   /**
 103    * Returns the true cause of this exception, the wrapped runtime
 104    * exception.
 105    *
 106    * @return the wrapped exception.
 107    */
 108   public RuntimeException getTargetException()
 109   {
 110     return runtimeException;
 111   }
 112
 113 }
 114