01 /*
02 * Copyright 2001-2004 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.util.logging;
27
28 /**
29 * ErrorManager objects can be attached to Handlers to process
30 * any error that occur on a Handler during Logging.
31 * <p>
32 * When processing logging output, if a Handler encounters problems
33 * then rather than throwing an Exception back to the issuer of
34 * the logging call (who is unlikely to be interested) the Handler
35 * should call its associated ErrorManager.
36 */
37
38 public class ErrorManager {
39 private boolean reported = false;
40
41 /*
42 * We declare standard error codes for important categories of errors.
43 */
44
45 /**
46 * GENERIC_FAILURE is used for failure that don't fit
47 * into one of the other categories.
48 */
49 public final static int GENERIC_FAILURE = 0;
50 /**
51 * WRITE_FAILURE is used when a write to an output stream fails.
52 */
53 public final static int WRITE_FAILURE = 1;
54 /**
55 * FLUSH_FAILURE is used when a flush to an output stream fails.
56 */
57 public final static int FLUSH_FAILURE = 2;
58 /**
59 * CLOSE_FAILURE is used when a close of an output stream fails.
60 */
61 public final static int CLOSE_FAILURE = 3;
62 /**
63 * OPEN_FAILURE is used when an open of an output stream fails.
64 */
65 public final static int OPEN_FAILURE = 4;
66 /**
67 * FORMAT_FAILURE is used when formatting fails for any reason.
68 */
69 public final static int FORMAT_FAILURE = 5;
70
71 /**
72 * The error method is called when a Handler failure occurs.
73 * <p>
74 * This method may be overriden in subclasses. The default
75 * behavior in this base class is that the first call is
76 * reported to System.err, and subsequent calls are ignored.
77 *
78 * @param msg a descriptive string (may be null)
79 * @param ex an exception (may be null)
80 * @param code an error code defined in ErrorManager
81 */
82 public synchronized void error(String msg, Exception ex, int code) {
83 if (reported) {
84 // We only report the first error, to avoid clogging
85 // the screen.
86 return;
87 }
88 reported = true;
89 String text = "java.util.logging.ErrorManager: " + code;
90 if (msg != null) {
91 text = text + ": " + msg;
92 }
93 System.err.println(text);
94 if (ex != null) {
95 ex.printStackTrace();
96 }
97 }
98 }
|