001    /* WriteAbortedException.java -- wraps an exception thrown while writing
002       Copyright (C) 1998, 2000, 2002, 2005  Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package java.io;
040    
041    /**
042      * This exception is thrown when another ObjectStreamException occurs during
043      * a serialization read or write. The stream is reset, and deserialized
044      * objects are discarded.
045      *
046      * @author Aaron M. Renn (arenn@urbanophile.com)
047      * @author Eric Blake (ebb9@email.byu.edu)
048      * @since 1.1
049      * @status updated to 1.4
050      */
051    public class WriteAbortedException extends ObjectStreamException
052    {
053      /**
054       * Compatible with JDK 1.1+.
055       */
056      private static final long serialVersionUID = -3326426625597282442L;
057    
058      /**
059       * The cause of this exception. This pre-dates the exception chaining
060       * of Throwable; and although you can change this field, you are wiser
061       * to leave it alone.
062       *
063       * @serial the exception cause
064       */
065      public Exception detail;
066    
067      /**
068       * Create a new WriteAbortedException with a specified message and
069       * cause.
070       *
071       * @param msg the message
072       * @param detail the cause
073       */
074      public WriteAbortedException(String msg, Exception detail)
075      {
076        super(msg);
077        initCause(detail);
078        this.detail = detail;
079      }
080    
081      /**
082       * This method returns a message indicating what went wrong, in this
083       * format:
084       * <code>super.getMessage() + (detail == null ? "" : "; " + detail)</code>.
085       *
086       * @return the chained message
087       */
088      public String getMessage()
089      {
090        if (detail == this || detail == null)
091          return super.getMessage();
092        return super.getMessage() + "; " + detail;
093      }
094    
095      /**
096       * Returns the cause of this exception. Note that this may not be the
097       * original cause, thanks to the <code>detail</code> field being public
098       * and non-final (yuck). However, to avoid violating the contract of
099       * Throwable.getCause(), this returns null if <code>detail == this</code>,
100       * as no exception can be its own cause.
101       *
102       * @return the cause
103       * @since 1.4
104       */
105      public Throwable getCause()
106      {
107        return detail == this ? null : detail;
108      }
109    } // class WriteAbortedException