1 /*
   2  * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.rmi.server;
  27 
  28 /**
  29  * A <code>ServerCloneException</code> is thrown if a remote exception occurs
  30  * during the cloning of a <code>UnicastRemoteObject</code>.
  31  *
  32  * <p>As of release 1.4, this exception has been retrofitted to conform to
  33  * the general purpose exception-chaining mechanism.  The "nested exception"
  34  * that may be provided at construction time and accessed via the public
  35  * {@link #detail} field is now known as the <i>cause</i>, and may be
  36  * accessed via the {@link Throwable#getCause()} method, as well as
  37  * the aforementioned "legacy field."
  38  *
  39  * <p>Invoking the method {@link Throwable#initCause(Throwable)} on an
  40  * instance of <code>ServerCloneException</code> always throws {@link
  41  * IllegalStateException}.
  42  *
  43  * @author  Ann Wollrath
  44  * @since   1.1
  45  * @see     java.rmi.server.UnicastRemoteObject#clone()
  46  */
  47 public class ServerCloneException extends CloneNotSupportedException {
  48 
  49     /**
  50      * The cause of the exception.
  51      *
  52      * <p>This field predates the general-purpose exception chaining facility.
  53      * The {@link Throwable#getCause()} method is now the preferred means of
  54      * obtaining this information.
  55      *
  56      * @serial
  57      */
  58     public Exception detail;
  59 
  60     /* indicate compatibility with JDK 1.1.x version of class */
  61     private static final long serialVersionUID = 6617456357664815945L;
  62 
  63     /**
  64      * Constructs a <code>ServerCloneException</code> with the specified
  65      * detail message.
  66      *
  67      * @param s the detail message.
  68      */
  69     public ServerCloneException(String s) {
  70         super(s);
  71         initCause(null);  // Disallow subsequent initCause
  72     }
  73 
  74     /**
  75      * Constructs a <code>ServerCloneException</code> with the specified
  76      * detail message and cause.
  77      *
  78      * @param s the detail message.
  79      * @param cause the cause
  80      */
  81     public ServerCloneException(String s, Exception cause) {
  82         super(s);
  83         initCause(null);  // Disallow subsequent initCause
  84         detail = cause;
  85     }
  86 
  87     /**
  88      * Returns the detail message, including the message from the cause, if
  89      * any, of this exception.
  90      *
  91      * @return the detail message
  92      */
  93     public String getMessage() {
  94         if (detail == null)
  95             return super.getMessage();
  96         else
  97             return super.getMessage() +
  98                 "; nested exception is: \n\t" +
  99                 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 }