author | darcy |
Thu, 29 Aug 2019 16:31:34 -0700 | |
changeset 57956 | e0b8b019d2f5 |
parent 47216 | 71c04702a3d5 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
57956
e0b8b019d2f5
8229997: Apply java.io.Serial annotations in java.base
darcy
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 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. |
|
2 | 24 |
*/ |
25 |
||
26 |
package java.io; |
|
27 |
||
28 |
/** |
|
29 |
* Signals that one of the ObjectStreamExceptions was thrown during a |
|
30 |
* write operation. Thrown during a read operation when one of the |
|
31 |
* ObjectStreamExceptions was thrown during a write operation. The |
|
32 |
* exception that terminated the write can be found in the detail |
|
33 |
* field. The stream is reset to it's initial state and all references |
|
34 |
* to objects already deserialized are discarded. |
|
35 |
* |
|
36 |
* <p>As of release 1.4, this exception has been retrofitted to conform to |
|
37 |
* the general purpose exception-chaining mechanism. The "exception causing |
|
38 |
* the abort" that is provided at construction time and |
|
39 |
* accessed via the public {@link #detail} field is now known as the |
|
40 |
* <i>cause</i>, and may be accessed via the {@link Throwable#getCause()} |
|
41 |
* method, as well as the aforementioned "legacy field." |
|
42 |
* |
|
43 |
* @author unascribed |
|
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
5506
diff
changeset
|
44 |
* @since 1.1 |
2 | 45 |
*/ |
46 |
public class WriteAbortedException extends ObjectStreamException { |
|
57956
e0b8b019d2f5
8229997: Apply java.io.Serial annotations in java.base
darcy
parents:
47216
diff
changeset
|
47 |
@java.io.Serial |
2 | 48 |
private static final long serialVersionUID = -3326426625597282442L; |
49 |
||
50 |
/** |
|
51 |
* Exception that was caught while writing the ObjectStream. |
|
52 |
* |
|
53 |
* <p>This field predates the general-purpose exception chaining facility. |
|
54 |
* The {@link Throwable#getCause()} method is now the preferred means of |
|
55 |
* obtaining this information. |
|
56 |
* |
|
57 |
* @serial |
|
58 |
*/ |
|
59 |
public Exception detail; |
|
60 |
||
61 |
/** |
|
62 |
* Constructs a WriteAbortedException with a string describing |
|
63 |
* the exception and the exception causing the abort. |
|
64 |
* @param s String describing the exception. |
|
65 |
* @param ex Exception causing the abort. |
|
66 |
*/ |
|
67 |
public WriteAbortedException(String s, Exception ex) { |
|
68 |
super(s); |
|
69 |
initCause(null); // Disallow subsequent initCause |
|
70 |
detail = ex; |
|
71 |
} |
|
72 |
||
73 |
/** |
|
74 |
* Produce the message and include the message from the nested |
|
75 |
* exception, if there is one. |
|
76 |
*/ |
|
77 |
public String getMessage() { |
|
78 |
if (detail == null) |
|
79 |
return super.getMessage(); |
|
80 |
else |
|
81 |
return super.getMessage() + "; " + detail.toString(); |
|
82 |
} |
|
83 |
||
84 |
/** |
|
85 |
* Returns the exception that terminated the operation (the <i>cause</i>). |
|
86 |
* |
|
87 |
* @return the exception that terminated the operation (the <i>cause</i>), |
|
88 |
* which may be null. |
|
89 |
* @since 1.4 |
|
90 |
*/ |
|
91 |
public Throwable getCause() { |
|
92 |
return detail; |
|
93 |
} |
|
94 |
} |