annotate dwt/DWTError.d @ 71:295b29fc7d13

Renamed SWT to DWT
author Frank Benoit <benoit@tionex.de>
date Tue, 15 Jan 2008 06:44:34 +0100
parents dwt/SWTError.d@8cec8f536af3
children 5899e0b43e5d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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
1 /*******************************************************************************
0
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 *******************************************************************************/
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
11 module dwt.DWTError;
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 import dwt.DWT;
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 error is thrown whenever an unrecoverable error
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
20 * occurs internally in DWT. The message text and error code
0
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 * throwable 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 * SWTErrors are thrown when something fails internally which
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
27 * 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
28 * 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
29 * is left in a known-to-be-unrecoverable state (eg. it runs out
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * of callback resources). SWTErrors should not occur in typical
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * programs, although "high reliability" applications should
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * still catch them.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * </p><p>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
34 * 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
35 * error codes to the appropriate exception class (DWTError,
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
36 * DWTException, or IllegalArgumentException) and to provide
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
37 * human readable strings for DWT error codes.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
40 * @see DWTException
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
41 * @see DWT#error(int)
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
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 public class DWTError : PlatformException {
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 /**
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
46 * The DWT error code, one of DWT.ERROR_*.
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 */
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
48 public int code;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49
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
50 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
51 * 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
52 * 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
53 */
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 public TracedException throwable;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 //static final long serialVersionUID = 3833467327105808433L;
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 filled in. The error code is set to an
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * unspecified value.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 public this () {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
64 this (DWT.ERROR_UNSPECIFIED);
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
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * stack trace and message filled in. The error code is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * set to an unspecified value. Specifying <code>null</code>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * as the message is equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 public this (char[] message) {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
76 this (DWT.ERROR_UNSPECIFIED, message);
0
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 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * Constructs a new instance of this class with its
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * stack trace and error code filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
83 * @param code the DWT error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 public this (int code) {
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
86 this (code, DWT.findErrorText (code));
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, error code and message filled in.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * Specifying <code>null</code> as the message is
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * equivalent to specifying an empty string.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
95 * @param code the DWT error code
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * @param message the detail message for the exception
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 public this (int code, char[] 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
99 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
100 this.code = code;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * Returns the underlying throwable that caused the problem,
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 * or null if this information is not available.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * NOTE: This method overrides Throwable.getCause() that was
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 * added to JDK1.4. It is necessary to override this method
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 * in order for inherited printStackTrace() methods to work.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 * @return the underlying throwable
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 *
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 * @since 3.1
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 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
116 return throwable;
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 /**
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
120 * Returns the string describing this DWTError object.
0
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 * 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
123 * which caused this DWTError (if this information is available).
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 * </p>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
125 * @return the error message string of this DWTError object
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 public char[] 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
128 if (throwable is null)
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 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
130 return super.toString () ~ " (" ~ throwable.toString () ~ ")"; //$NON-NLS-1$ //$NON-NLS-2$
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 /**
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 * Outputs a printable representation of this error's
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 * stack trace on the standard error stream.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 * <p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 * Note: printStackTrace(PrintStream) and printStackTrace(PrintWriter)
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 * are not provided in order to maintain compatibility with CLDC.
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 * </p>
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 */
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 public void printStackTrace () {
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 Stderr.formatln( "stacktrace follows (if feature compiled in)" );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 foreach( msg; this ){
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 Stderr.formatln( "{}", msg );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 }
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
146 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
147 Stderr.formatln ("*** Stack trace of contained error ***"); //$NON-NLS-1$
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 foreach( msg; throwable ){
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 Stderr.formatln( "{}", msg );
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 }
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
151 }
0
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 }
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153
c8ad75f8819e first import
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 }