libjava/java/io/WriteAbortedException.java

   1 /* WriteAbortedException.java -- wraps an exception thrown while writing
   2    Copyright (C) 1998, 2000, 2002, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.io;
  40
  41 /**
  42   * This exception is thrown when another ObjectStreamException occurs during
  43   * a serialization read or write. The stream is reset, and deserialized
  44   * objects are discarded.
  45   *
  46   * @author Aaron M. Renn (arenn@urbanophile.com)
  47   * @author Eric Blake (ebb9@email.byu.edu)
  48   * @since 1.1
  49   * @status updated to 1.4
  50   */
  51 public class WriteAbortedException extends ObjectStreamException
  52 {
  53   /**
  54    * Compatible with JDK 1.1+.
  55    */
  56   private static final long serialVersionUID = -3326426625597282442L;
  57
  58   /**
  59    * The cause of this exception. This pre-dates the exception chaining
  60    * of Throwable; and although you can change this field, you are wiser
  61    * to leave it alone.
  62    *
  63    * @serial the exception cause
  64    */
  65   public Exception detail;
  66
  67   /**
  68    * Create a new WriteAbortedException with a specified message and
  69    * cause.
  70    *
  71    * @param msg the message
  72    * @param detail the cause
  73    */
  74   public WriteAbortedException(String msg, Exception detail)
  75   {
  76     super(msg);
  77     initCause(detail);
  78     this.detail = detail;
  79   }
  80
  81   /**
  82    * This method returns a message indicating what went wrong, in this
  83    * format:
  84    * <code>super.getMessage() + (detail == null ? "" : "; " + detail)</code>.
  85    *
  86    * @return the chained message
  87    */
  88   public String getMessage()
  89   {
  90     if (detail == this || detail == null)
  91       return super.getMessage();
  92     return super.getMessage() + "; " + detail;
  93   }
  94
  95   /**
  96    * Returns the cause of this exception. Note that this may not be the
  97    * original cause, thanks to the <code>detail</code> field being public
  98    * and non-final (yuck). However, to avoid violating the contract of
  99    * 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