KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > tools > common > util > diagnostics > Reporter


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package com.sun.enterprise.tools.common.util.diagnostics;
25
26 import java.io.*;
27 import java.util.*;
28 //import netscape.toolutil.util.*;
29 //import netscape.toolutil.util.Registry;
30
31 /** Wrapper class for ReporterImpl(s)
32  ** Will create & track ReporterImpl's if desired
33  ** provides an easy-to-type selection of static methods for calling the default reporter
34  **/
35 public class Reporter implements IReporterEnum
36 {
37     ///////////////////////////////////////////////////////////////////////////////////////////////////////
38 /////////////////////////// //////////////////////////////////////////////////
39 /////////////////////////// Configurating Stuff //////////////////////////////////////////////////
40 /////////////////////////// //////////////////////////////////////////////////
41 ///////////////////////////////////////////////////////////////////////////////////////////////////////
42
43     /** Gain access to the default ReporterImpl object.
44      * @return The default ReporterImpl object.
45      */
46     public static ReporterImpl get()
47     {
48         return getDefaultReporter();
49     }
50
51     ///////////////////////////////////////////////////////////////////////////////////////////////////////
52
53         /** Change the message severity level that will trigger output
54          * @param level The verbosity increases as the level decresses. The value 1000 shutdown the Reporter.
55          */
56     public static void setSeverityLevel(int level)
57     {
58         getDefaultReporter().setSeverityLevel(level);
59     }
60
61     ///////////////////////////////////////////////////////////////////////////////////////////////////////
62
63         /** Change the message severity level that will trigger output
64          * @param level A textual description of the severity level. Key values include: ALL,NOISY,EVERYTHING,ON",MONDO,YES,TRUE,DUMP,MAX [which turn the message volume up] and NO,OFF,FALSE,QUIET,MIN [which turn the volume down] as well as the sveroty level names.
65          * return DISABLED;
66          */
67     public static void setSeverityLevel(String JavaDoc level)
68     {
69         getDefaultReporter().setSeverityLevel(level);
70     }
71
72     ///////////////////////////////////////////////////////////////////////////////////////////////////////
73
74         /** Determine the current severity level.
75          * @return the severity levels integer value.
76          */
77     public static int getSeverityLevel()
78     {
79         return getDefaultReporter().getSeverityLevel();
80     }
81     
82     ///////////////////////////////////////////////////////////////////////////////////////////////////////
83 /////////////////////////// //////////////////////////////////////////////////
84 /////////////////////////// Message Writing //////////////////////////////////////////////////
85 /////////////////////////// //////////////////////////////////////////////////
86 ///////////////////////////////////////////////////////////////////////////////////////////////////////
87
88         /** Messages output at the lowest severity level.
89          * @param o The text of the message will be the output of this object's toString()
90          */
91     public static void verbose(Object JavaDoc o)
92     {
93         getDefaultReporter().verbose(o);
94     }
95
96     ///////////////////////////////////////////////////////////////////////////////////////////////////////
97
98         /**
99          * @see verbose(Object)
100          */
101     public static void info(Object JavaDoc o)
102     {
103         getDefaultReporter().info(o);
104     }
105
106     ///////////////////////////////////////////////////////////////////////////////////////////////////////
107
108         /**
109          * @see verbose(Object)
110          */
111     public static void warn(Object JavaDoc o)
112     {
113         getDefaultReporter().warn(o);
114     }
115
116     ///////////////////////////////////////////////////////////////////////////////////////////////////////
117
118         /**
119          * @see verbose(Object)
120          */
121     public static void warning(Object JavaDoc o)
122     {
123         getDefaultReporter().warning(o);
124     }
125
126     ///////////////////////////////////////////////////////////////////////////////////////////////////////
127
128         /**
129          * @see verbose(Object)
130          */
131     public static void error(Object JavaDoc o)
132     {
133         getDefaultReporter().error(o);
134     }
135     
136     ///////////////////////////////////////////////////////////////////////////////////////////////////////
137
138         /**
139          * @see verbose(Object)
140          */
141     public static void critical(Object JavaDoc o)
142     {
143         getDefaultReporter().critical(o);
144     }
145     ///////////////////////////////////////////////////////////////////////////////////////////////////////
146
147         /**
148          * @see verbose(Object)
149          */
150     public static void crit(Object JavaDoc o)
151     {
152         getDefaultReporter().crit(o);
153     }
154
155     ///////////////////////////////////////////////////////////////////////////////////////////////////////
156
157         /** Dump information via the Reporter about an object
158          * @param o The object to dump information about.
159          * @param s A string to preceed the object dump
160          */
161     public static void dump(Object JavaDoc o, String JavaDoc s)
162     {
163         getDefaultReporter().dump(o, s);
164     }
165
166     ///////////////////////////////////////////////////////////////////////////////////////////////////////
167
168         /** Print a string at "DUMP" severity level
169          * @param s The message to report.
170          */
171     public static void dump(String JavaDoc s)
172     {
173         getDefaultReporter().dump(s);
174     }
175
176
177     ///////////////////////////////////////////////////////////////////////////////////////////////////////
178
179         /** Dump an object, with no "extra string" associated with the output.
180          * @param o The object to dump
181          */
182     public static void dump(Object JavaDoc o)
183     {
184         getDefaultReporter().dump(o);
185     }
186
187
188     ///////////////////////////////////////////////////////////////////////////////////////////////////////
189 /////////////////////////// //////////////////////////////////////////////////
190 /////////////////////////// ASSERTION STUFF //////////////////////////////////////////////////
191 /////////////////////////// //////////////////////////////////////////////////
192 ///////////////////////////////////////////////////////////////////////////////////////////////////////
193
194     // TBD: Nice to have the assertIt's print the CallerInfo stuff.
195 // lots-o-typing needed!!
196
197         /** Provide an assertIt mechanism. The assertion will be checked if the severity level is set to ASSERT or lower.
198          * @param s The assertion will fail and cause a message and throw a run-time exception is the
199          * argument is null or is zero length.
200          */
201     public static void assertIt(String JavaDoc s)
202     {
203         getDefaultReporter().assertIt(s);
204     }
205
206     ///////////////////////////////////////////////////////////////////////////////////////////////////////
207
208         /** Provide an assertIt mechanism. The assertion will be checked if the severity level is set to ASSERT or lower.
209          * @param checkme The assertion will fail and cause a message and throw a run-time exception is the
210          * argument is null or is zero length.
211          * @param s Additional information to add to the assertion's text message.
212          */
213     public static void assertIt(String JavaDoc checkme, String JavaDoc s)
214     {
215         getDefaultReporter().assertIt(checkme, s);
216     }
217
218     ///////////////////////////////////////////////////////////////////////////////////////////////////////
219
220         /**
221          * @see assertIt(String)
222          */
223     public static void assertIt(boolean b)
224     {
225         getDefaultReporter().assertIt(b);
226     }
227
228     ///////////////////////////////////////////////////////////////////////////////////////////////////////
229
230         /**
231          * @see assertIt(String,String)
232          */
233     public static void assertIt(boolean b, String JavaDoc s)
234     {
235         getDefaultReporter().assertIt(b, s);
236     }
237
238     ///////////////////////////////////////////////////////////////////////////////////////////////////////
239
240         /**
241          * @see assertIt(String)
242          */
243     public static void assertIt(Object JavaDoc o)
244     {
245         getDefaultReporter().assertIt(o);
246     }
247
248     ///////////////////////////////////////////////////////////////////////////////////////////////////////
249
250         /**
251          * @see assertIt(String,String)
252          */
253     public static void assertIt(Object JavaDoc o, String JavaDoc s)
254     {
255         getDefaultReporter().assertIt(o, s);
256     }
257
258     ///////////////////////////////////////////////////////////////////////////////////////////////////////
259
260         /**
261          * @see assertIt(String)
262          */
263     public static void assertIt(double z)
264     {
265         getDefaultReporter().assertIt(z);
266     }
267
268     ///////////////////////////////////////////////////////////////////////////////////////////////////////
269
270         /**
271          * @see assertIt(String,String)
272          */
273     public static void assertIt(double z, String JavaDoc s)
274     {
275         getDefaultReporter().assertIt(z, s);
276     }
277
278     ///////////////////////////////////////////////////////////////////////////////////////////////////////
279
280         /**
281          * @see assertIt(String)
282          */
283     public static void assertIt(long l)
284     {
285         getDefaultReporter().assertIt(l);
286     }
287
288     ///////////////////////////////////////////////////////////////////////////////////////////////////////
289
290         /**
291          * @see assertIt(String,String)
292          */
293     public static void assertIt(long l, String JavaDoc s)
294     {
295         getDefaultReporter().assertIt(l, s);
296     }
297
298   
299     ///////////////////////////////////////////////////////////////////////////////////////////////////////
300 /////////////////////////// //////////////////////////////////////////////////
301 /////////////////////////// PRIVATE STUFF //////////////////////////////////////////////////
302 /////////////////////////// //////////////////////////////////////////////////
303 ///////////////////////////////////////////////////////////////////////////////////////////////////////
304
305     protected Reporter()
306     {
307     }
308     
309     ///////////////////////////////////////////////////////////////////////////////////////////////////////
310
311     private static void debug(String JavaDoc s)
312     {
313         if(doDebug)
314             System.err.println(s);
315     }
316     
317     ///////////////////////////////////////////////////////////////////////////////////////////////////////
318
319     private static ReporterImpl getDefaultReporter()
320     {
321         if(defaultReporter == null)
322         {
323             System.err.println("Internal Error in Reporter -- couldn't find default reporter!");//NOI18N
324 defaultReporter = new ReporterImpl();
325         }
326
327         return defaultReporter;
328     }
329
330     ///////////////////////////////////////////////////////////////////////////////////////////////////////
331
332     private static ReporterImpl defaultReporter = null;
333     private static final boolean doDebug = false;
334     
335     ///////////////////////////////////////////////////////////////////////////////////////////////////////
336
337     static
338     {
339         CallerInfo.addToGlobalIgnore(new Reporter());
340         
341         defaultReporter = new ReporterImpl();
342
343         if(defaultReporter == null)
344         {
345             System.err.println("Internal Error in Reporter -- couldn't make default reporter!");//NOI18N
346 }
347     }
348 }
349
350
Popular Tags