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.server;
027
028 /**
029 * A <code>ServerCloneException</code> is thrown if a remote exception occurs
030 * during the cloning of a <code>UnicastRemoteObject</code>.
031 *
032 * <p>As of release 1.4, this exception has been retrofitted to conform to
033 * the general purpose exception-chaining mechanism. The "nested exception"
034 * that may be provided at construction time and accessed via the public
035 * {@link #detail} field is now known as the <i>cause</i>, and may be
036 * accessed via the {@link Throwable#getCause()} method, as well as
037 * the aforementioned "legacy field."
038 *
039 * <p>Invoking the method {@link Throwable#initCause(Throwable)} on an
040 * instance of <code>ServerCloneException</code> always throws {@link
041 * IllegalStateException}.
042 *
043 * @version 1.27, 05/05/07
044 * @author Ann Wollrath
045 * @since JDK1.1
046 * @see java.rmi.server.UnicastRemoteObject#clone()
047 */
048 public class ServerCloneException extends CloneNotSupportedException {
049
050 /**
051 * The cause of the exception.
052 *
053 * <p>This field predates the general-purpose exception chaining facility.
054 * The {@link Throwable#getCause()} method is now the preferred means of
055 * obtaining this information.
056 *
057 * @serial
058 */
059 public Exception detail;
060
061 /* indicate compatibility with JDK 1.1.x version of class */
062 private static final long serialVersionUID = 6617456357664815945L;
063
064 /**
065 * Constructs a <code>ServerCloneException</code> with the specified
066 * detail message.
067 *
068 * @param s the detail message.
069 */
070 public ServerCloneException(String s) {
071 super (s);
072 initCause(null); // Disallow subsequent initCause
073 }
074
075 /**
076 * Constructs a <code>ServerCloneException</code> with the specified
077 * detail message and cause.
078 *
079 * @param s the detail message.
080 * @param cause the cause
081 */
082 public ServerCloneException(String s, Exception cause) {
083 super (s);
084 initCause(null); // Disallow subsequent initCause
085 detail = cause;
086 }
087
088 /**
089 * Returns the detail message, including the message from the cause, if
090 * any, of this exception.
091 *
092 * @return the detail message
093 */
094 public String getMessage() {
095 if (detail == null)
096 return super .getMessage();
097 else
098 return super .getMessage() + "; nested exception is: \n\t"
099 + detail.toString();
100 }
101
102 /**
103 * Returns the cause of this exception. This method returns the value
104 * of the {@link #detail} field.
105 *
106 * @return the cause, which may be <tt>null</tt>.
107 * @since 1.4
108 */
109 public Throwable getCause() {
110 return detail;
111 }
112 }
|