PatternParserEx


1   /*
2     * JBoss, Home of Professional Open Source
3     * Copyright 2005, JBoss Inc., and individual contributors as indicated
4     * by the @authors tag. See the copyright.txt in the distribution for a
5     * full listing of individual contributors.
6     *
7     * This is free software; you can redistribute it and/or modify it
8     * under the terms of the GNU Lesser General Public License as
9     * published by the Free Software Foundation; either version 2.1 of
10    * the License, or (at your option) any later version.
11    *
12    * This software is distributed in the hope that it will be useful,
13    * but WITHOUT ANY WARRANTY; without even the implied warranty of
14    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15    * Lesser General Public License for more details.
16    *
17    * You should have received a copy of the GNU Lesser General Public
18    * License along with this software; if not, write to the Free
19    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21    */
22  package org.jboss.logging.layout;
23  
24  import org.apache.log4j.helpers.PatternConverter;
25  import org.apache.log4j.helpers.PatternParser;
26  
27  /** A subclass of the log4j PatternParser that add the following conversion
28  characters:
29  
30     <p>
31     <table border="1" CELLPADDING="8">
32     <th>Conversion Character</th>
33     <th>Effect</th>
34  
35     <tr>
36       <td align=center><b>z</b></td>
37       <td>Used to output current thread NDC value. This can be used to obtain
38        an NDC to augment any NDC associated with the LoggingEvent. This might
39        be necessary if the LoggingEvent has been serialized between VMs.
40       </td>
41     </tr>
42     <tr>
43       <td align=center><b>Z</b></td>
44       <td>Used to output current thread MDC value. This can be used to obtain
45        an MDC to augment any MDC associated with the LoggingEvent. This might
46        be necessary if the LoggingEvent has been serialized between VMs.
47        The Z conversion character must be followed by the key for the map placed
48        between braces, as in %Z{theKey} where theKey is the key.
49        The value in the MDC corresponding to the key will be output.
50       </td>
51     </tr>
52  
53   * @author Scott.Stark@jboss.org
54   * @version $Revision: 1958 $
55   */
56  public class PatternParserEx extends PatternParser
57  {
58     /** Creates a new instance of PatternParser */
59     public PatternParserEx(String   pattern)
60     {
61        super(pattern);
62     }
63  
64     protected void finalizeConverter(char c)
65     {
66        PatternConverter pc = null;
67        switch(c)
68        {
69           case 'z':
70              pc = new ThreadNDCConverter(formattingInfo);
71              currentLiteral.setLength(0);
72           break;
73           case 'Z':
74              String   key = extractOption();
75              pc = new ThreadMDCConverter(formattingInfo, key);
76              currentLiteral.setLength(0);
77           break;
78           default:
79              super.finalizeConverter(c);
80           return;
81        }
82        addConverter(pc);
83     }
84  }
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags