Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.3 / log4j-1.2-api / xref / org / apache / log4j / builders / layout / TTCCLayoutBuilder.html
blob: 15356522ed2200e7d7fb6e185330c5bf8e749839 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>TTCCLayoutBuilder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/log4j/builders/layout/TTCCLayoutBuilder.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.log4j.builders.layout;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.Layout;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.bridge.LayoutWrapper;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.builders.AbstractBuilder;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.builders.BooleanHolder;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.builders.Holder;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.config.Log4j1Configuration;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.config.PropertiesConfiguration;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.xml.XmlConfiguration;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.layout.PatternLayout;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.log4j.builders.BuilderManager.CATEGORY;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.log4j.xml.XmlConfiguration.*;
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Build a Pattern Layout</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> @Plugin(name = <span class="jxr_string">"org.apache.log4j.TTCCLayout"</span>, category = CATEGORY)
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/log4j/builders/layout/TTCCLayoutBuilder.html">TTCCLayoutBuilder</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/log4j/builders/AbstractBuilder.html">AbstractBuilder</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../org/apache/log4j/builders/layout/LayoutBuilder.html">LayoutBuilder</a> {
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/log4j/Logger.html">Logger</a> LOGGER = StatusLogger.getLogger();
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String THREAD_PRINTING_PARAM = <span class="jxr_string">"ThreadPrinting"</span>;
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CATEGORY_PREFIXING_PARAM = <span class="jxr_string">"CategoryPrefixing"</span>;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONTEXT_PRINTING_PARAM = <span class="jxr_string">"ContextPrinting"</span>;
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DATE_FORMAT_PARAM = <span class="jxr_string">"DateFormat"</span>;
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TIMEZONE_FORMAT = <span class="jxr_string">"TimeZone"</span>;
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/log4j/builders/layout/TTCCLayoutBuilder.html">TTCCLayoutBuilder</a>() {
<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/log4j/builders/layout/TTCCLayoutBuilder.html">TTCCLayoutBuilder</a>(String prefix, Properties props) {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">super</strong>(prefix, props);
<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> @Override
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/log4j/Layout.html">Layout</a> parseLayout(Element layoutElement, <a href="../../../../../org/apache/log4j/xml/XmlConfiguration.html">XmlConfiguration</a> config) {
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">final</strong> Holder&lt;Boolean&gt; threadPrinting = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/log4j/builders/BooleanHolder.html">BooleanHolder</a>();
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">final</strong> Holder&lt;Boolean&gt; categoryPrefixing = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/log4j/builders/BooleanHolder.html">BooleanHolder</a>();
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">final</strong> Holder&lt;Boolean&gt; contextPrinting = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/log4j/builders/BooleanHolder.html">BooleanHolder</a>();
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">final</strong> Holder&lt;String&gt; dateFormat = <strong class="jxr_keyword">new</strong> Holder&lt;&gt;();
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">final</strong> Holder&lt;String&gt; timezone = <strong class="jxr_keyword">new</strong> Holder&lt;&gt;();
<a class="jxr_linenumber" name="L66" href="#L66">66</a> forEachElement(layoutElement.getElementsByTagName(<span class="jxr_string">"param"</span>), (currentElement) -&gt; {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">if</strong> (currentElement.getTagName().equals(PARAM_TAG)) {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">switch</strong> (currentElement.getAttribute(NAME_ATTR)) {
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">case</strong> THREAD_PRINTING_PARAM:
<a class="jxr_linenumber" name="L70" href="#L70">70</a> threadPrinting.set(Boolean.parseBoolean(currentElement.getAttribute(VALUE_ATTR)));
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">case</strong> CATEGORY_PREFIXING_PARAM:
<a class="jxr_linenumber" name="L73" href="#L73">73</a> categoryPrefixing.set(Boolean.parseBoolean(currentElement.getAttribute(VALUE_ATTR)));
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">case</strong> CONTEXT_PRINTING_PARAM:
<a class="jxr_linenumber" name="L76" href="#L76">76</a> contextPrinting.set(Boolean.parseBoolean(currentElement.getAttribute(VALUE_ATTR)));
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">case</strong> DATE_FORMAT_PARAM:
<a class="jxr_linenumber" name="L79" href="#L79">79</a> dateFormat.set(currentElement.getAttribute(VALUE_ATTR));
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">case</strong> TIMEZONE_FORMAT:
<a class="jxr_linenumber" name="L82" href="#L82">82</a> timezone.set(currentElement.getAttribute(VALUE_ATTR));
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a> });
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">return</strong> createLayout(threadPrinting.get(), categoryPrefixing.get(), contextPrinting.get(),
<a class="jxr_linenumber" name="L88" href="#L88">88</a> dateFormat.get(), timezone.get(), config);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> @Override
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/log4j/Layout.html">Layout</a> parseLayout(<a href="../../../../../org/apache/log4j/config/PropertiesConfiguration.html">PropertiesConfiguration</a> config) {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">boolean</strong> threadPrinting = getBooleanProperty(THREAD_PRINTING_PARAM);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">boolean</strong> categoryPrefixing = getBooleanProperty(CATEGORY_PREFIXING_PARAM);
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">boolean</strong> contextPrinting = getBooleanProperty(CONTEXT_PRINTING_PARAM);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> String dateFormat = getProperty(DATE_FORMAT_PARAM);
<a class="jxr_linenumber" name="L97" href="#L97">97</a> String timezone = getProperty(TIMEZONE_FORMAT);
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> createLayout(threadPrinting, categoryPrefixing, contextPrinting,
<a class="jxr_linenumber" name="L100" href="#L100">100</a> dateFormat, timezone, config);
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/log4j/Layout.html">Layout</a> createLayout(<strong class="jxr_keyword">boolean</strong> threadPrinting, <strong class="jxr_keyword">boolean</strong> categoryPrefixing, <strong class="jxr_keyword">boolean</strong> contextPrinting,
<a class="jxr_linenumber" name="L104" href="#L104">104</a> String dateFormat, String timezone, <a href="../../../../../org/apache/log4j/config/Log4j1Configuration.html">Log4j1Configuration</a> config) {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (dateFormat != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">if</strong> (RELATIVE.equalsIgnoreCase(dateFormat)) {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> sb.append(<span class="jxr_string">"%r "</span>);
<a class="jxr_linenumber" name="L109" href="#L109">109</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> sb.append(<span class="jxr_string">"%d{"</span>).append(dateFormat).append(<span class="jxr_string">"}"</span>);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">if</strong> (timezone != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> sb.append(<span class="jxr_string">"{"</span>).append(timezone).append(<span class="jxr_string">"}"</span>);
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> sb.append(<span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">if</strong> (threadPrinting) {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> sb.append(<span class="jxr_string">"[%t] "</span>);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> sb.append(<span class="jxr_string">"%p "</span>);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">if</strong> (categoryPrefixing) {
<a class="jxr_linenumber" name="L122" href="#L122">122</a> sb.append(<span class="jxr_string">"%c "</span>);
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">if</strong> (contextPrinting) {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> sb.append(<span class="jxr_string">"%notEmpty{%ndc }"</span>);
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a> sb.append(<span class="jxr_string">"- %m%n"</span>);
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/log4j/bridge/LayoutWrapper.html">LayoutWrapper</a>(PatternLayout.newBuilder()
<a class="jxr_linenumber" name="L129" href="#L129">129</a> .withPattern(sb.toString())
<a class="jxr_linenumber" name="L130" href="#L130">130</a> .withConfiguration(config)
<a class="jxr_linenumber" name="L131" href="#L131">131</a> .build());
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>