rt/emul/compact/src/main/java/java/io/WriteAbortedException.java
changeset 772 d382dacfd73f
parent 601 5198affdb915
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/rt/emul/compact/src/main/java/java/io/WriteAbortedException.java	Tue Feb 26 16:54:16 2013 +0100
     1.3 @@ -0,0 +1,93 @@
     1.4 +/*
     1.5 + * Copyright (c) 1996, 2005, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package java.io;
    1.30 +
    1.31 +/**
    1.32 + * Signals that one of the ObjectStreamExceptions was thrown during a
    1.33 + * write operation.  Thrown during a read operation when one of the
    1.34 + * ObjectStreamExceptions was thrown during a write operation.  The
    1.35 + * exception that terminated the write can be found in the detail
    1.36 + * field. The stream is reset to it's initial state and all references
    1.37 + * to objects already deserialized are discarded.
    1.38 + *
    1.39 + * <p>As of release 1.4, this exception has been retrofitted to conform to
    1.40 + * the general purpose exception-chaining mechanism.  The "exception causing
    1.41 + * the abort" that is provided at construction time and
    1.42 + * accessed via the public {@link #detail} field is now known as the
    1.43 + * <i>cause</i>, and may be accessed via the {@link Throwable#getCause()}
    1.44 + * method, as well as the aforementioned "legacy field."
    1.45 + *
    1.46 + * @author  unascribed
    1.47 + * @since   JDK1.1
    1.48 + */
    1.49 +public class WriteAbortedException extends ObjectStreamException {
    1.50 +    private static final long serialVersionUID = -3326426625597282442L;
    1.51 +
    1.52 +    /**
    1.53 +     * Exception that was caught while writing the ObjectStream.
    1.54 +     *
    1.55 +     * <p>This field predates the general-purpose exception chaining facility.
    1.56 +     * The {@link Throwable#getCause()} method is now the preferred means of
    1.57 +     * obtaining this information.
    1.58 +     *
    1.59 +     * @serial
    1.60 +     */
    1.61 +    public Exception detail;
    1.62 +
    1.63 +    /**
    1.64 +     * Constructs a WriteAbortedException with a string describing
    1.65 +     * the exception and the exception causing the abort.
    1.66 +     * @param s   String describing the exception.
    1.67 +     * @param ex  Exception causing the abort.
    1.68 +     */
    1.69 +    public WriteAbortedException(String s, Exception ex) {
    1.70 +        super(s);
    1.71 +        initCause(null);  // Disallow subsequent initCause
    1.72 +        detail = ex;
    1.73 +    }
    1.74 +
    1.75 +    /**
    1.76 +     * Produce the message and include the message from the nested
    1.77 +     * exception, if there is one.
    1.78 +     */
    1.79 +    public String getMessage() {
    1.80 +        if (detail == null)
    1.81 +            return super.getMessage();
    1.82 +        else
    1.83 +            return super.getMessage() + "; " + detail.toString();
    1.84 +    }
    1.85 +
    1.86 +    /**
    1.87 +     * Returns the exception that terminated the operation (the <i>cause</i>).
    1.88 +     *
    1.89 +     * @return  the exception that terminated the operation (the <i>cause</i>),
    1.90 +     *          which may be null.
    1.91 +     * @since   1.4
    1.92 +     */
    1.93 +    public Throwable getCause() {
    1.94 +        return detail;
    1.95 +    }
    1.96 +}