FileDocCategorySizeDatePackage
RemoteException.javaAPI DocJava SE 5 API3198Fri Aug 26 14:57:10 BST 2005java.rmi

RemoteException

public class RemoteException extends IOException
A RemoteException is the common superclass for a number of communication-related exceptions that may occur during the execution of a remote method call. Each method of a remote interface, an interface that extends java.rmi.Remote, must list RemoteException in its throws clause.

As of release 1.4, this exception has been retrofitted to conform to the general purpose exception-chaining mechanism. The "wrapped remote exception" that may be provided at construction time and accessed via the public {@link #detail} field is now known as the cause, and may be accessed via the {@link Throwable#getCause()} method, as well as the aforementioned "legacy field."

Invoking the method {@link Throwable#initCause(Throwable)} on an instance of RemoteException always throws {@link IllegalStateException}.

version
1.24, 12/19/03
author
Ann Wollrath
since
JDK1.1

Fields Summary
private static final long
serialVersionUID
public Throwable
detail
The cause of the remote exception.

This field predates the general-purpose exception chaining facility. The {@link Throwable#getCause()} method is now the preferred means of obtaining this information.

Constructors Summary
public RemoteException()
Constructs a RemoteException.


            
      
        initCause(null);  // Disallow subsequent initCause
public RemoteException(String s)
Constructs a RemoteException with the specified detail message.

param
s the detail message

	super(s);
        initCause(null);  // Disallow subsequent initCause
public RemoteException(String s, Throwable cause)
Constructs a RemoteException with the specified detail message and cause. This constructor sets the {@link #detail} field to the specified Throwable.

param
s the detail message
param
cause the cause

	super(s);
        initCause(null);  // Disallow subsequent initCause
	detail = cause;
Methods Summary
public java.lang.ThrowablegetCause()
Returns the cause of this exception. This method returns the value of the {@link #detail} field.

return
the cause, which may be null.
since
1.4

        return detail;
public java.lang.StringgetMessage()
Returns the detail message, including the message from the cause, if any, of this exception.

return
the detail message

	if (detail == null) {
	    return super.getMessage();
	} else {
	    return super.getMessage() + "; nested exception is: \n\t" +
		detail.toString();
	}