PageRenderTime 49ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/apache-log4j-1.2.17/site/xref/org/apache/log4j/Layout.html

#
HTML | 103 lines | 101 code | 2 blank | 0 comment | 0 complexity | a8bf835e7d7585753cb2a5f865bb20d5 MD5 | raw file
Possible License(s): Apache-2.0
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  3. <head>
  4. <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
  5. <title>Layout xref</title>
  6. <link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
  7. </head>
  8. <body>
  9. <div id="overview"><a href="../../../../apidocs/org/apache/log4j/Layout.html">View Javadoc</a></div><pre>
  10. <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
  11. <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
  12. <a name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
  13. <a name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
  14. <a name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
  15. <a name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
  16. <a name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
  17. <a name="8" href="#8">8</a> <em class="jxr_comment"> * </em>
  18. <a name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
  19. <a name="10" href="#10">10</a> <em class="jxr_comment"> * </em>
  20. <a name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
  21. <a name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
  22. <a name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
  23. <a name="14" href="#14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
  24. <a name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the License.</em>
  25. <a name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
  26. <a name="17" href="#17">17</a>
  27. <a name="18" href="#18">18</a> <strong class="jxr_keyword">package</strong> org.apache.log4j;
  28. <a name="19" href="#19">19</a>
  29. <a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.OptionHandler;
  30. <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.LoggingEvent;
  31. <a name="22" href="#22">22</a>
  32. <a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
  33. <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> Extend this abstract class to create your own log layout format.</em>
  34. <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> </em>
  35. <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> @author Ceki G&amp;uuml;lc&amp;uuml;</em>
  36. <a name="27" href="#27">27</a>
  37. <a name="28" href="#28">28</a> <em class="jxr_javadoccomment">*/</em>
  38. <a name="29" href="#29">29</a>
  39. <a name="30" href="#30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/log4j/Layout.html">Layout</a> implements <a href="../../../org/apache/log4j/spi/OptionHandler.html">OptionHandler</a> {
  40. <a name="31" href="#31">31</a>
  41. <a name="32" href="#32">32</a> <em class="jxr_comment">// Note that the line.separator property can be looked up even by</em>
  42. <a name="33" href="#33">33</a> <em class="jxr_comment">// applets.</em>
  43. <a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> String LINE_SEP = System.getProperty(<span class="jxr_string">"line.separator"</span>);
  44. <a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> LINE_SEP_LEN = LINE_SEP.length();
  45. <a name="36" href="#36">36</a>
  46. <a name="37" href="#37">37</a>
  47. <a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
  48. <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> Implement this method to create your own layout format.</em>
  49. <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
  50. <a name="41" href="#41">41</a> <strong class="jxr_keyword">abstract</strong>
  51. <a name="42" href="#42">42</a> <strong class="jxr_keyword">public</strong>
  52. <a name="43" href="#43">43</a> String format(<a href="../../../org/apache/log4j/spi/LoggingEvent.html">LoggingEvent</a> event);
  53. <a name="44" href="#44">44</a>
  54. <a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
  55. <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> Returns the content type output by this layout. The base class</em>
  56. <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> returns "text/plain". </em>
  57. <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
  58. <a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong>
  59. <a name="50" href="#50">50</a> String getContentType() {
  60. <a name="51" href="#51">51</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"text/plain"</span>;
  61. <a name="52" href="#52">52</a> }
  62. <a name="53" href="#53">53</a>
  63. <a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
  64. <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> Returns the header for the layout format. The base class returns</em>
  65. <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> &lt;code&gt;null&lt;/code&gt;. */</em>
  66. <a name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong>
  67. <a name="58" href="#58">58</a> String getHeader() {
  68. <a name="59" href="#59">59</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
  69. <a name="60" href="#60">60</a> }
  70. <a name="61" href="#61">61</a>
  71. <a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
  72. <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> Returns the footer for the layout format. The base class returns</em>
  73. <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> &lt;code&gt;null&lt;/code&gt;. */</em>
  74. <a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong>
  75. <a name="66" href="#66">66</a> String getFooter() {
  76. <a name="67" href="#67">67</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
  77. <a name="68" href="#68">68</a> }
  78. <a name="69" href="#69">69</a>
  79. <a name="70" href="#70">70</a>
  80. <a name="71" href="#71">71</a>
  81. <a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
  82. <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> If the layout handles the throwable object contained within</em>
  83. <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> {@link LoggingEvent}, then the layout should return</em>
  84. <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> &lt;code&gt;false&lt;/code&gt;. Otherwise, if the layout ignores throwable</em>
  85. <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> object, then the layout should return &lt;code&gt;true&lt;/code&gt;.</em>
  86. <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> If ignoresThrowable is true, the appender is responsible for</em>
  87. <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> rendering the throwable.</em>
  88. <a name="79" href="#79">79</a>
  89. <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> &lt;p&gt;The {@link SimpleLayout}, {@link TTCCLayout}, {@link</em>
  90. <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> PatternLayout} all return &lt;code&gt;true&lt;/code&gt;. The {@link</em>
  91. <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> org.apache.log4j.xml.XMLLayout} returns &lt;code&gt;false&lt;/code&gt;.</em>
  92. <a name="83" href="#83">83</a>
  93. <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> @since 0.8.4 */</em>
  94. <a name="85" href="#85">85</a> <strong class="jxr_keyword">abstract</strong>
  95. <a name="86" href="#86">86</a> <strong class="jxr_keyword">public</strong>
  96. <a name="87" href="#87">87</a> <strong class="jxr_keyword">boolean</strong> ignoresThrowable();
  97. <a name="88" href="#88">88</a>
  98. <a name="89" href="#89">89</a> }
  99. </pre>
  100. <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
  101. </html>