001/* RuntimeMBeanException.java -- A user-defined management exception.
002   Copyright (C) 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.management;
039
040/**
041 * Represents an arbitrary runtime exception thrown by a management
042 * bean.  When a management bean executes code that causes a runtime
043 * exception to be thrown, the resulting exception is wrapped inside a
044 * {@link RuntimeMBeanException}.  Calling {@link
045 * getTargetException()} will return the wrapped exception.
046 *
047 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
048 * @since 1.5
049 */
050public class RuntimeMBeanException
051  extends JMRuntimeException
052{
053
054  /**
055   * Compatible with JDK 1.5
056   */
057  private static final long serialVersionUID = 5274912751982730171L;
058
059  /**
060   * The target exception.
061   *
062   * @serial the target exception.
063   */
064  private RuntimeException runtimeException;
065
066  /**
067   * Constructs a new <code>RuntimeMBeanException</code> wrapping
068   * the specified exception.
069   *
070   * @param e the exception to be wrapped.
071   */
072  public RuntimeMBeanException(RuntimeException e)
073  {
074    super();
075    runtimeException = e;
076  }
077
078  /**
079   * Constructs a new <code>RuntimeMBeanException</code> wrapping
080   * the specified exception and using the supplied message.
081   *
082   * @param e the exception to be wrapped.
083   * @param message the error message to give to the user.
084   */
085  public RuntimeMBeanException(RuntimeException e, String message)
086  {
087    super(message);
088    runtimeException = e;
089  }
090
091  /**
092   * Returns the true cause of this exception, the wrapped runtime
093   * exception.
094   *
095   * @return the wrapped exception.
096   */
097  public Throwable getCause()
098  {
099    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