KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.apache.avalon.framework.ExceptionUtil;
58 import org.apache.log.LogEvent;
59 import org.apache.log.format.ExtendedPatternFormatter;
60 import org.apache.log.format.PatternFormatter;
61 import org.apache.log.util.StackIntrospector;
62
63 /**
64  * This formatter extends ExtendedPatternFormatter so that
65  * CascadingExceptions are formatted with all nested exceptions.
66  *
67  * <ul>
68  * <li><code>class</code> : outputs the name of the class that has logged the
69  * message. The optional <code>short</code> subformat removes the
70  * package name. Warning : this pattern works only if formatting occurs in
71  * the same thread as the call to Logger, i.e. it won't work with
72  * <code>AsyncLogTarget</code>.</li>
73  * </ul>
74  *
75  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
76  * @version CVS $Revision: 1.27 $ $Date: 2003/02/11 16:25:49 $
77  */
78 public class AvalonFormatter
79     extends ExtendedPatternFormatter
80 {
81     private static final int TYPE_CLASS = MAX_TYPE + 1;
82
83     private static final String JavaDoc TYPE_CLASS_STR = "class";
84     private static final String JavaDoc TYPE_CLASS_SHORT_STR = "short";
85
86     /**
87      * The constant defining the default stack depth when
88      * none other is specified.
89      *
90      * @since 4.1.2
91      */
92     public static final int DEFAULT_STACK_DEPTH = 8;
93
94     /**
95      * The constant defining the default behaviour for printing
96      * nested exceptions.
97      *
98      * @since 4.1.2
99      */
100     public static final boolean DEFAULT_PRINT_CASCADING = true;
101
102     //The depth to which stacktraces are printed out
103 private final int m_stackDepth;
104
105     //Determines if nested exceptions should be logged
106 private final boolean m_printCascading;
107
108     /**
109      * Construct the formatter with the specified pattern
110      * and which which prints out exceptions to stackDepth of 8.
111      *
112      * @param pattern The pattern to use to format the log entries
113      * @since 4.1
114     */
115     public AvalonFormatter( final String JavaDoc pattern )
116     {
117         this( pattern, DEFAULT_STACK_DEPTH, DEFAULT_PRINT_CASCADING );
118     }
119
120     /**
121      * Construct the formatter with the specified pattern
122      * and which which prints out exceptions to stackDepth specified.
123      *
124      * @param pattern The pattern to use to format the log entries
125      * @param stackDepth The depth to which stacktraces are printed out
126      * @param printCascading true enables printing of nested exceptions,
127      * false only prints out the outermost exception
128      * @since 4.1.2
129      */
130     public AvalonFormatter( final String JavaDoc pattern, final int stackDepth,
131                             final boolean printCascading )
132     {
133         super( pattern );
134         m_stackDepth = stackDepth;
135         m_printCascading = printCascading;
136     }
137
138     /**
139      * Utility method to format stack trace.
140      *
141      * @param throwable the throwable instance
142      * @param format ancilliary format parameter - allowed to be null
143      * @return the formatted string
144      */
145     protected String JavaDoc getStackTrace( final Throwable JavaDoc throwable, final String JavaDoc format )
146     {
147         if( null == throwable )
148         {
149             return "";
150         }
151         return ExceptionUtil.printStackTrace( throwable, m_stackDepth, m_printCascading );
152     }
153
154     /**
155      * Retrieve the type-id for a particular string.
156      *
157      * @param type the string
158      * @return the type-id
159      */
160     protected int getTypeIdFor( final String JavaDoc type )
161     {
162         if( type.equalsIgnoreCase( TYPE_CLASS_STR ) )
163         {
164             return TYPE_CLASS;
165         }
166         else
167         {
168             return super.getTypeIdFor( type );
169         }
170     }
171
172    /**
173     * Return the result of formaltting a pattern run.
174     * @param event the log event
175     * @param run the patter formatter pattern run
176     * @return the formatted string
177     */
178     protected String JavaDoc formatPatternRun( LogEvent event, PatternFormatter.PatternRun run )
179     {
180         switch( run.m_type )
181         {
182             case TYPE_CLASS:
183                 return getClass( run.m_format );
184             default:
185                 return super.formatPatternRun( event, run );
186         }
187     }
188
189     /**
190      * Finds the class that has called Logger.
191      */
192     private String JavaDoc getClass( String JavaDoc format )
193     {
194         final Class JavaDoc clazz = StackIntrospector.getCallerClass( Logger.class );
195
196         if( null == clazz )
197         {
198             return "Unknown-class";
199         }
200         else
201         {
202             // Found : the caller is the previous stack element
203 String JavaDoc className = clazz.getName();
204
205             // Handle optional format
206 if( TYPE_CLASS_SHORT_STR.equalsIgnoreCase( format ) )
207             {
208                 int pos = className.lastIndexOf( '.' );
209
210                 if( pos >= 0 )
211                 {
212                     className = className.substring( pos + 1 );
213                 }
214             }
215
216             return className;
217         }
218     }
219 }
220
Popular Tags