annotate dwt/SWTException.d @ 10:63c023465156

moved from org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:58:37 +0100
parents ad2b69216039
children 8cec8f536af3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
11 module dwt.SWTException;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
13 import dwt.SWT;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import tango.core.Exception;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import tango.io.Stdout;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * This runtime exception is thrown whenever a recoverable error
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * occurs internally in SWT. The message text and error code
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * provide a further description of the problem. The exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * has a <code>throwable</code> field which holds the underlying
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * exception that caused the problem (if this information is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * available (i.e. it may be null)).
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * SWTExceptions are thrown when something fails internally,
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * but SWT is left in a known stable state (eg. a widget call
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * was made from a non-u/i thread, or there is failure while
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * reading an Image because the source file was corrupt).
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * @see SWTError
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 public class SWTException : TracedException {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * The SWT error code, one of SWT.ERROR_*.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 public int code;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * The underlying throwable that caused the problem,
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * or null if this information is not available.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 public TracedException throwable;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 //static final long serialVersionUID = 3257282552304842547L;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * stack trace filled in. The error code is set to an
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * unspecified value.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 public this () {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 this (SWT.ERROR_UNSPECIFIED);
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * stack trace and message filled in. The error code is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * set to an unspecified value. Specifying <code>null</code>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * as the message is equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 public this (char[] message) {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 this (SWT.ERROR_UNSPECIFIED, message);
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * stack trace and error code filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * @param code the SWT error code
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 public this (int code) {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 this (code, SWT.findErrorText (code));
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * stack trace, error code and message filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * Specifying <code>null</code> as the message is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * @param code the SWT error code
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 public this (int code, char[] message) {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 super (message);
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 this.code = code;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * Returns the underlying throwable that caused the problem,
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * or null if this information is not available.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 * NOTE: This method overrides Throwable.getCause() that was
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * added to JDK1.4. It is necessary to override this method
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * in order for inherited printStackTrace() methods to work.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * @return the underlying throwable
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * @since 3.1
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 public TracedException getCause() {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 return throwable;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 * Returns the string describing this SWTException object.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 * It is combined with the message string of the Throwable
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 * which caused this SWTException (if this information is available).
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 * @return the error message string of this SWTException object
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 public char[] getMessage () {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 if (throwable is null) return super.toString ();
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 return super.toString () ~ " (" ~ throwable.toString () ~ ")"; //$NON-NLS-1$ //$NON-NLS-2$
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 * Outputs a printable representation of this exception's
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 * stack trace on the standard error stream.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 * Note: printStackTrace(PrintStream) and printStackTrace(PrintWriter)
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 * are not provided in order to maintain compatibility with CLDC.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 public void printStackTrace () {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 Stderr.formatln( "stacktrace follows (if feature compiled in)" );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 foreach( msg; this ){
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 Stderr.formatln( "{}", msg );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 if ( throwable !is null) {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 Stderr.formatln ("*** Stack trace of contained exception ***"); //$NON-NLS-1$
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 foreach( msg; throwable ){
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 Stderr.formatln( "{}", msg );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146