KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > logging > layout > PatternLayout


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.PatternParser;
25
26 /** A subclass of the log4j PatternLayout that add the following conversion
27 characters:
28
29    <p>
30    <table border="1" CELLPADDING="8">
31    <th>Conversion Character</th>
32    <th>Effect</th>
33
34    <tr>
35      <td align=center><b>z</b></td>
36      <td>Used to output current thread NDC value. This can be used to obtain
37       an NDC to augment any NDC associated with the LoggingEvent. This might
38       be necessary if the LoggingEvent has been serialized between VMs.
39      </td>
40    </tr>
41    <tr>
42      <td align=center><b>Z</b></td>
43      <td>Used to output current thread MDC value. This can be used to obtain
44       an MDC to augment any MDC associated with the LoggingEvent. This might
45       be necessary if the LoggingEvent has been serialized between VMs.
46       The Z conversion character must be followed by the key for the map placed
47       between braces, as in %Z{theKey} where theKey is the key.
48       The value in the MDC corresponding to the key will be output.
49      </td>
50    </tr>
51
52  * @author Scott.Stark@jboss.org
53  * @version $Revision: 1958 $
54  */
55 public class PatternLayout extends org.apache.log4j.PatternLayout
56 {
57
58   protected PatternParser createPatternParser(String JavaDoc pattern)
59   {
60     return new PatternParserEx(pattern);
61   }
62
63 }
64
Popular Tags