KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > framework > logger > Logger


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software
24  * itself, if and wherever such third-party acknowledgments
25  * normally appear.
26  *
27  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
28  * must not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55 package org.apache.avalon.framework.logger;
56
57 /**
58  * This is a facade for the different logging subsystems.
59  * It offers a simplified interface that follows IOC patterns
60  * and a simplified priority/level/severity abstraction.
61  *
62  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
63  * @version CVS $Revision: 1.14 $ $Date: 2003/02/11 15:58:41 $
64  */
65 public interface Logger
66 {
67     /**
68      * Log a debug message.
69      *
70      * @param message the message
71      */
72     void debug( String JavaDoc message );
73
74     /**
75      * Log a debug message.
76      *
77      * @param message the message
78      * @param throwable the throwable
79      */
80     void debug( String JavaDoc message, Throwable JavaDoc throwable );
81
82     /**
83      * Determine if messages of priority "debug" will be logged.
84      *
85      * @return true if "debug" messages will be logged
86      */
87     boolean isDebugEnabled();
88
89     /**
90      * Log a info message.
91      *
92      * @param message the message
93      */
94     void info( String JavaDoc message );
95
96     /**
97      * Log a info message.
98      *
99      * @param message the message
100      * @param throwable the throwable
101      */
102     void info( String JavaDoc message, Throwable JavaDoc throwable );
103
104     /**
105      * Determine if messages of priority "info" will be logged.
106      *
107      * @return true if "info" messages will be logged
108      */
109     boolean isInfoEnabled();
110
111     /**
112      * Log a warn message.
113      *
114      * @param message the message
115      */
116     void warn( String JavaDoc message );
117
118     /**
119      * Log a warn message.
120      *
121      * @param message the message
122      * @param throwable the throwable
123      */
124     void warn( String JavaDoc message, Throwable JavaDoc throwable );
125
126     /**
127      * Determine if messages of priority "warn" will be logged.
128      *
129      * @return true if "warn" messages will be logged
130      */
131     boolean isWarnEnabled();
132
133     /**
134      * Log a error message.
135      *
136      * @param message the message
137      */
138     void error( String JavaDoc message );
139
140     /**
141      * Log a error message.
142      *
143      * @param message the message
144      * @param throwable the throwable
145      */
146     void error( String JavaDoc message, Throwable JavaDoc throwable );
147
148     /**
149      * Determine if messages of priority "error" will be logged.
150      *
151      * @return true if "error" messages will be logged
152      */
153     boolean isErrorEnabled();
154
155     /**
156      * Log a fatalError message.
157      *
158      * @param message the message
159      */
160     void fatalError( String JavaDoc message );
161
162     /**
163      * Log a fatalError message.
164      *
165      * @param message the message
166      * @param throwable the throwable
167      */
168     void fatalError( String JavaDoc message, Throwable JavaDoc throwable );
169
170     /**
171      * Determine if messages of priority "fatalError" will be logged.
172      *
173      * @return true if "fatalError" messages will be logged
174      */
175     boolean isFatalErrorEnabled();
176
177     /**
178      * Create a new child logger.
179      * The name of the child logger is [current-loggers-name].[passed-in-name]
180      * Throws <code>IllegalArgumentException</code> if name has an empty element name
181      *
182      * @param name the subname of this logger
183      * @return the new logger
184      */
185     Logger getChildLogger( String JavaDoc name );
186 }
187
Popular Tags