annotate dwt/DWTError.d @ 361:4bffbf81e2d6

redirect direct prints to DwtLogger
author Frank Benoit <benoit@tionex.de>
date Fri, 20 Mar 2009 21:00:06 +0100
parents c0d810de7093
children
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
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * This error is thrown whenever an unrecoverable error
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
23 * occurs internally in DWT. The message text and error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * provide a further description of the problem. The exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * has a <code>throwable</code> field which holds the underlying
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * throwable that caused the problem (if this information is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * available (i.e. it may be null)).
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * SWTErrors are thrown when something fails internally which
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
30 * 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
31 * 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
32 * is left in a known-to-be-unrecoverable state (eg. it runs out
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * of callback resources). SWTErrors should not occur in typical
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * programs, although "high reliability" applications should
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * still catch them.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * </p><p>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
37 * 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
38 * error codes to the appropriate exception class (DWTError,
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
39 * DWTException, or IllegalArgumentException) and to provide
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
40 * human readable strings for DWT error codes.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
43 * @see DWTException
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
44 * @see DWT#error(int)
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
45 * @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
46 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
48 public class DWTError : PlatformException {
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
50 * The DWT error code, one of DWT.ERROR_*.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 */
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
52 public int code;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
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
54 /**
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 * 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
56 * 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
57 */
231
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
58 public Exception throwable( Exception e ){
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
59 this.next = e;
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
60 return this.next;
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
61 }
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
62 public Exception throwable(){
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
63 return this.next;
654b7d7cc33c instead of throwable member var, use the Exception.next
Frank Benoit <benoit@tionex.de>
parents: 158
diff changeset
64 }
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 //static final long serialVersionUID = 3833467327105808433L;
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * stack trace filled in. The error code is set to an
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * unspecified value.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 public this () {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
74 this (DWT.ERROR_UNSPECIFIED);
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 }
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 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * stack trace and message filled in. The error code is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * set to an unspecified value. Specifying <code>null</code>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * as the message is equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
85 public this (String message) {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
86 this (DWT.ERROR_UNSPECIFIED, message);
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 }
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 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * stack trace and error code filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
93 * @param code the DWT error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 public this (int code) {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
96 this (code, DWT.findErrorText (code));
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 }
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 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * stack trace, error code and message filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * Specifying <code>null</code> as the message is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
105 * @param code the DWT error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
108 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
109 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
110 this.code = code;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 }
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 * Returns the underlying throwable that caused the problem,
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * or null if this information is not available.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 * NOTE: This method overrides Throwable.getCause() that was
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 * added to JDK1.4. It is necessary to override this method
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 * in order for inherited printStackTrace() methods to work.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 * @return the underlying throwable
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 * @since 3.1
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 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
126 return throwable;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 /**
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
130 * Returns the string describing this DWTError object.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 * 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
133 * which caused this DWTError (if this information is available).
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 * </p>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
135 * @return the error message string of this DWTError object
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 231
diff changeset
137 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
138 if (throwable is null)
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 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
140 return super.toString () ~ " (" ~ throwable.toString () ~ ")"; //$NON-NLS-1$ //$NON-NLS-2$
0
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 * Outputs a printable representation of this error's
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 * stack trace on the standard error stream.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 * Note: printStackTrace(PrintStream) and printStackTrace(PrintWriter)
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 * are not provided in order to maintain compatibility with CLDC.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 public void printStackTrace () {
361
4bffbf81e2d6 redirect direct prints to DwtLogger
Frank Benoit <benoit@tionex.de>
parents: 259
diff changeset
152 getDwtLogger().error( "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
153 foreach( msg; info ){
361
4bffbf81e2d6 redirect direct prints to DwtLogger
Frank Benoit <benoit@tionex.de>
parents: 259
diff changeset
154 getDwtLogger().error( "{}", msg );
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 }
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
156 if ( throwable !is null) {
361
4bffbf81e2d6 redirect direct prints to DwtLogger
Frank Benoit <benoit@tionex.de>
parents: 259
diff changeset
157 getDwtLogger().error ("*** 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
158 foreach( msg; throwable.info ){
361
4bffbf81e2d6 redirect direct prints to DwtLogger
Frank Benoit <benoit@tionex.de>
parents: 259
diff changeset
159 getDwtLogger().error( "{}", msg );
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 }
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
161 }
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
162 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164 }