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.log.format;
56  
57  import org.apache.log.LogEvent;
58  import org.apache.log.format.ExtendedPatternFormatter;
59  import org.apache.log.format.PatternFormatter;
60  import org.apache.log.util.StackIntrospector;
61  
62  /**
63   * This formatter extends ExtendedPatternFormatter so that
64   * CascadingExceptions are formatted with all nested exceptions.
65   *
66   * <ul>
67   * <li><code>class</code> : outputs the name of the class that has logged the
68   *     message. The optional <code>short</code> subformat removes the
69   *     package name. Warning : this pattern works only if formatting occurs in
70   *     the same thread as the call to Logger, i.e. it won't work with
71   *     <code>AsyncLogTarget</code>.</li>
72   * </ul>
73   *
74   * @deprecated Use <code>org.apache.avalon.framework.logger.AvalonFormatter</code>
75   *             instead of this one.
76   * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
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   TYPE_CLASS_STR = "class";
84      private static final String   TYPE_CLASS_SHORT_STR = "short";
85  
86      /**
87       * The constant defining the default stack depth when
88       * none other is specified.
89       */
90      public static final int DEFAULT_STACK_DEPTH = 8;
91  
92      /**
93       * The constant defining the default behaviour for printing
94       * nested exceptions.
95       */
96      public static final boolean DEFAULT_PRINT_CASCADING = true;
97  
98      //The depth to which stacktraces are printed out
99      private final int m_stackDepth;
100 
101     //Determines if nested exceptions should be logged
102     private final boolean m_printCascading;
103 
104     /**
105      * Construct the formatter with the specified pattern
106      * and which which prints out exceptions to stackDepth of 8.
107      *
108      * @param pattern The pattern to use to format the log entries
109      */
110     public AvalonFormatter( final String   pattern )
111     {
112         this( pattern, DEFAULT_STACK_DEPTH, DEFAULT_PRINT_CASCADING );
113     }
114 
115     /**
116      * Construct the formatter with the specified pattern
117      * and which which prints out exceptions to stackDepth specified.
118      *
119      * @param pattern The pattern to use to format the log entries
120      * @param stackDepth The depth to which stacktraces are printed out
121      * @param printCascading true enables printing of nested exceptions,
122      *   false only prints out the outermost exception
123      */
124     public AvalonFormatter( final String   pattern, final int stackDepth,
125                             final boolean printCascading )
126     {
127         super( pattern );
128         m_stackDepth = stackDepth;
129         m_printCascading = printCascading;
130     }
131 
132     /**
133      * Utility method to format stack trace.
134      *
135      * @param throwable the throwable instance
136      * @param format ancilliary format parameter - allowed to be null
137      * @return the formatted string
138      */
139     protected String   getStackTrace( final Throwable   throwable, final String   format )
140     {
141         if( null == throwable )
142         {
143             return "";
144         }
145         return ExceptionUtil.printStackTrace( throwable, m_stackDepth, m_printCascading );
146     }
147 
148     /**
149      * Retrieve the type-id for a particular string.
150      *
151      * @param type the string
152      * @return the type-id
153      */
154     protected int getTypeIdFor( final String   type )
155     {
156         if( type.equalsIgnoreCase( TYPE_CLASS_STR ) )
157         {
158             return TYPE_CLASS;
159         }
160         else
161         {
162             return super.getTypeIdFor( type );
163         }
164     }
165 
166     protected String   formatPatternRun( LogEvent event, PatternFormatter.PatternRun run )
167     {
168         switch( run.m_type )
169         {
170             case TYPE_CLASS:
171                 return getClass( run.m_format );
172             default:
173                 return super.formatPatternRun( event, run );
174         }
175     }
176 
177     /**
178      * Finds the class that has called Logger.
179      */
180     private String   getClass( String   format )
181     {
182         return "Unknown-class";
183     }
184 }
185
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags