001 /*
002 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.rmi;
027
028 /**
029 * A <code>RemoteException</code> is the common superclass for a number of
030 * communication-related exceptions that may occur during the execution of a
031 * remote method call. Each method of a remote interface, an interface that
032 * extends <code>java.rmi.Remote</code>, must list
033 * <code>RemoteException</code> in its throws clause.
034 *
035 * <p>As of release 1.4, this exception has been retrofitted to conform to
036 * the general purpose exception-chaining mechanism. The "wrapped remote
037 * exception" that may be provided at construction time and accessed via
038 * the public {@link #detail} field is now known as the <i>cause</i>, and
039 * may be accessed via the {@link Throwable#getCause()} method, as well as
040 * the aforementioned "legacy field."
041 *
042 * <p>Invoking the method {@link Throwable#initCause(Throwable)} on an
043 * instance of <code>RemoteException</code> always throws {@link
044 * IllegalStateException}.
045 *
046 * @version 1.31, 05/05/07
047 * @author Ann Wollrath
048 * @since JDK1.1
049 */
050 public class RemoteException extends java.io.IOException {
051
052 /* indicate compatibility with JDK 1.1.x version of class */
053 private static final long serialVersionUID = -5148567311918794206L;
054
055 /**
056 * The cause of the remote exception.
057 *
058 * <p>This field predates the general-purpose exception chaining facility.
059 * The {@link Throwable#getCause()} method is now the preferred means of
060 * obtaining this information.
061 *
062 * @serial
063 */
064 public Throwable detail;
065
066 /**
067 * Constructs a <code>RemoteException</code>.
068 */
069 public RemoteException() {
070 initCause(null); // Disallow subsequent initCause
071 }
072
073 /**
074 * Constructs a <code>RemoteException</code> with the specified
075 * detail message.
076 *
077 * @param s the detail message
078 */
079 public RemoteException(String s) {
080 super (s);
081 initCause(null); // Disallow subsequent initCause
082 }
083
084 /**
085 * Constructs a <code>RemoteException</code> with the specified detail
086 * message and cause. This constructor sets the {@link #detail}
087 * field to the specified <code>Throwable</code>.
088 *
089 * @param s the detail message
090 * @param cause the cause
091 */
092 public RemoteException(String s, Throwable cause) {
093 super (s);
094 initCause(null); // Disallow subsequent initCause
095 detail = cause;
096 }
097
098 /**
099 * Returns the detail message, including the message from the cause, if
100 * any, of this exception.
101 *
102 * @return the detail message
103 */
104 public String getMessage() {
105 if (detail == null) {
106 return super .getMessage();
107 } else {
108 return super .getMessage() + "; nested exception is: \n\t"
109 + detail.toString();
110 }
111 }
112
113 /**
114 * Returns the cause of this exception. This method returns the value
115 * of the {@link #detail} field.
116 *
117 * @return the cause, which may be <tt>null</tt>.
118 * @since 1.4
119 */
120 public Throwable getCause() {
121 return detail;
122 }
123 }
|