1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.core.runtime;
import java.io.PrintStream;
import java.io.PrintWriter;
import org.eclipse.core.internal.runtime.PrintStackUtil;
/**
* A checked exception representing a failure.
* <p>
* Core exceptions contain a status object describing the cause of the exception.
* </p><p>
* This class can be used without OSGi running.
* </p>
* @see IStatus
*/
public class CoreException extends Exception {
/**
* All serializable objects should have a stable serialVersionUID
*/
private static final long serialVersionUID = 1L;
/** Status object. */
private final IStatus status;
/**
* Creates a new exception with the given status object. The message
* of the given status is used as the exception message.
*
* @param status the status object to be associated with this exception
*/
public CoreException(IStatus status) {
super(status.getMessage());
this.status = status;
}
/**
* Returns the cause of this exception, or <code>null</code> if none.
*
* @return the cause for this exception
* @since 3.4
*/
@Override
public Throwable getCause() {
return status.getException();
}
/**
* Returns the status object for this exception.
* <p>
* <b>IMPORTANT:</b><br>
* The result must NOT be used for logging, error reporting, or as a method
* return value, since that code pattern hides the original stack trace. Instead,
* create a new {@link Status} with your plug-in ID and this
* <code>CoreException</code>, and use that new status for error reporting
* or as a method return value. For example, instead of:
* </p>
* <pre>
* yourPlugin.getLog().log(exception.getStatus());
* </pre>
* Use:
* <pre>
* IStatus result = new Status(exception.getStatus().getSeverity(), pluginId, message, exception);
* yourPlugin.getLog().log(result);
* </pre>
*
* @return a status object
*/
public final IStatus getStatus() {
return status;
}
/**
* Prints a stack trace out for the exception, and
* any nested exception that it may have embedded in
* its Status object.
*/
@Override
public void printStackTrace() {
printStackTrace(System.err);
}
/**
* Prints a stack trace out for the exception, and
* any nested exception that it may have embedded in
* its Status object.
*
* @param output the stream to write to
*/
@Override
public void printStackTrace(PrintStream output) {
synchronized (output) {
super.printStackTrace(output);
PrintStackUtil.printChildren(status, output);
}
}
/**
* Prints a stack trace out for the exception, and
* any nested exception that it may have embedded in
* its Status object.
*
* @param output the stream to write to
*/
@Override
public void printStackTrace(PrintWriter output) {
synchronized (output) {
super.printStackTrace(output);
PrintStackUtil.printChildren(status, output);
}
}
}
|
