annotate dwt/DWTError.d @ 259:c0d810de7093

Update SWT 3.4M7 to 3.4
author Frank Benoit <benoit@tionex.de>
date Sun, 29 Jun 2008 14:33:38 +0200
parents 380bad9f6852
children 4bffbf81e2d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
0
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
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
11 * Frank Benoit <benoit@tionex.de>
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
13 module dwt.DWTError;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
15 import dwt.dwthelper.utils;
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
16
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
17 import dwt.DWT;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import tango.core.Exception;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import tango.io.Stdout;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * This error is thrown whenever an unrecoverable error
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
24 * occurs internally in DWT. The message text and error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * provide a further description of the problem. The exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * has a <code>throwable</code> field which holds the underlying
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * throwable that caused the problem (if this information is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * available (i.e. it may be null)).
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * SWTErrors are thrown when something fails internally which
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
31 * either leaves DWT in an unknown state (eg. the o/s call to
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
32 * remove an item from a list returns an error code) or when DWT
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * is left in a known-to-be-unrecoverable state (eg. it runs out
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * of callback resources). SWTErrors should not occur in typical
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * programs, although "high reliability" applications should
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * still catch them.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * </p><p>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
38 * This class also provides support methods used by DWT to match
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
39 * error codes to the appropriate exception class (DWTError,
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
40 * DWTException, or IllegalArgumentException) and to provide
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
41 * human readable strings for DWT error codes.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
44 * @see DWTException
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
45 * @see DWT#error(int)
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
46 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
49 public class DWTError : PlatformException {
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 /**
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
51 * The DWT error code, one of DWT.ERROR_*.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 */
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
53 public int code;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
55 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
56 * The underlying throwable that caused the problem,
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
57 * or null if this information is not available.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
58 */
231
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
59 public Exception throwable( Exception e ){
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
60 this.next = e;
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
61 return this.next;
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
62 }
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
63 public Exception throwable(){
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
64 return this.next;
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
65 }
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 //static final long serialVersionUID = 3833467327105808433L;
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 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * stack trace filled in. The error code is set to an
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * unspecified value.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 public this () {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
75 this (DWT.ERROR_UNSPECIFIED);
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * stack trace and message filled in. The error code is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * set to an unspecified value. Specifying <code>null</code>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * as the message is equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
86 public this (String message) {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
87 this (DWT.ERROR_UNSPECIFIED, message);
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * stack trace and error code filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
94 * @param code the DWT error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 public this (int code) {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
97 this (code, DWT.findErrorText (code));
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * stack trace, error code and message filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * Specifying <code>null</code> as the message is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
106 * @param code the DWT error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
109 public this (int code, String message) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
110 super (message);
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
111 this.code = code;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * Returns the underlying throwable that caused the problem,
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 * or null if this information is not available.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 * NOTE: This method overrides Throwable.getCause() that was
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 * added to JDK1.4. It is necessary to override this method
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 * in order for inherited printStackTrace() methods to work.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 * @return the underlying throwable
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 * @since 3.1
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 public Exception getCause() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
127 return throwable;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 /**
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
131 * Returns the string describing this DWTError object.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 * It is combined with the message string of the Throwable
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
134 * which caused this DWTError (if this information is available).
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 * </p>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
136 * @return the error message string of this DWTError object
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
138 public String getMessage () {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
139 if (throwable is null)
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 return super.toString();
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
141 return super.toString () ~ " (" ~ throwable.toString () ~ ")"; //$NON-NLS-1$ //$NON-NLS-2$
0
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 * Outputs a printable representation of this error's
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 * stack trace on the standard error stream.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 * Note: printStackTrace(PrintStream) and printStackTrace(PrintWriter)
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 * are not provided in order to maintain compatibility with CLDC.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 public void printStackTrace () {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 Stderr.formatln( "stacktrace follows (if feature compiled in)" );
158
de2578a843a7 Tango update to rev 3158, TracedException>Exception, fromUtf8z>fromStringz,Fix Bug in MenuItem Thanx to nascent for the report.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
154 foreach( msg; info ){
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 Stderr.formatln( "{}", msg );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 }
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
157 if ( throwable !is null) {
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
158 Stderr.formatln ("*** Stack trace of contained error ***"); //$NON-NLS-1$
158
de2578a843a7 Tango update to rev 3158, TracedException>Exception, fromUtf8z>fromStringz,Fix Bug in MenuItem Thanx to nascent for the report.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
159 foreach( msg; throwable.info ){
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 Stderr.formatln( "{}", msg );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
161 }
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
162 }
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
165 }