Source for java.rmi.RemoteException

   1: /* RemoteException.java -- common superclass for exceptions in java.rmi
   2:    Copyright (c) 1996, 1997, 1998, 1999, 2002, 2006
   3:    Free Software Foundation, Inc.
   4: 
   5: This file is part of GNU Classpath.
   6: 
   7: GNU Classpath is free software; you can redistribute it and/or modify
   8: it under the terms of the GNU General Public License as published by
   9: the Free Software Foundation; either version 2, or (at your option)
  10: any later version.
  11: 
  12: GNU Classpath is distributed in the hope that it will be useful, but
  13: WITHOUT ANY WARRANTY; without even the implied warranty of
  14: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15: General Public License for more details.
  16: 
  17: You should have received a copy of the GNU General Public License
  18: along with GNU Classpath; see the file COPYING.  If not, write to the
  19: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20: 02110-1301 USA.
  21: 
  22: Linking this library statically or dynamically with other modules is
  23: making a combined work based on this library.  Thus, the terms and
  24: conditions of the GNU General Public License cover the whole
  25: combination.
  26: 
  27: As a special exception, the copyright holders of this library give you
  28: permission to link this library with independent modules to produce an
  29: executable, regardless of the license terms of these independent
  30: modules, and to copy and distribute the resulting executable under
  31: terms of your choice, provided that you also meet, for each linked
  32: independent module, the terms and conditions of the license of that
  33: module.  An independent module is a module which is not derived from
  34: or based on this library.  If you modify this library, you may extend
  35: this exception to your version of the library, but you are not
  36: obligated to do so.  If you do not wish to do so, delete this
  37: exception statement from your version. */
  38: 
  39: package java.rmi;
  40: 
  41: import java.io.IOException;
  42: 
  43: /**
  44:  * The superclass of exceptions related to RMI (remote method invocation).
  45:  * Classes that implement <code>java.rmi.Remote</code> should list this
  46:  * exception in their throws clause.
  47:  *
  48:  * @author unknown
  49:  * @since 1.1
  50:  * @status updated to 1.4
  51:  */
  52: public class RemoteException extends IOException
  53: {
  54:   /**
  55:    * Compatible with JDK 1.2+.
  56:    */
  57:   private static final long serialVersionUID = -5148567311918794206l;
  58: 
  59:   /**
  60:    * The cause of this exception. This pre-dates the exception chaining
  61:    * of Throwable; and although you can change this field, you are wiser
  62:    * to leave it alone.
  63:    *
  64:    * @serial the exception cause
  65:    */
  66:   public Throwable detail;
  67: 
  68:   /**
  69:    * Create an exception with no message, and cause initialized to null.
  70:    */
  71:   public RemoteException()
  72:   {
  73:     this(null, null);
  74:   }
  75: 
  76:   /**
  77:    * Create an exception with the given message, and cause initialized to null.
  78:    *
  79:    * @param s the message
  80:    */
  81:   public RemoteException(String s)
  82:   {
  83:     this(s, null);
  84:   }
  85: 
  86:   /**
  87:    * Create an exception with the given message and cause.
  88:    *
  89:    * @param s the message
  90:    * @param e the cause
  91:    */
  92:   public RemoteException(String s, Throwable e)
  93:   {
  94:     super(s);
  95:     initCause(e);
  96:     detail = e;
  97:   }
  98: 
  99:   /**
 100:    * This method returns a message indicating what went wrong, in this
 101:    * format:
 102:    * <code>super.getMessage() + (detail == null ? ""
 103:    *    : "; nested exception is:\n\t" + detail)</code>.
 104:    *
 105:    * @return the chained message
 106:    */
 107:   public String getMessage()
 108:   {
 109:     if (detail == this || detail == null)
 110:       return super.getMessage();
 111:     return super.getMessage() + "; nested exception is:\n\t" + detail;
 112:   }
 113: 
 114:   /**
 115:    * Returns the cause of this exception. Note that this may not be the
 116:    * original cause, thanks to the <code>detail</code> field being public
 117:    * and non-final (yuck). However, to avoid violating the contract of
 118:    * Throwable.getCause(), this returns null if <code>detail == this</code>,
 119:    * as no exception can be its own cause.
 120:    *
 121:    * @return the cause
 122:    * @since 1.4
 123:    */
 124:   public Throwable getCause()
 125:   {
 126:     return detail == this ? null : detail;
 127:   }
 128: }