blob: ee377782179c7a5cbaa5f680c42c94e32ff007c6 [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=ISO-8859-1" />
<title>SimpleLayout xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/apache/log4j/SimpleLayout.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<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>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * </em>
<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>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * </em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong class="jxr_keyword">package</strong> org.apache.log4j;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.LoggingEvent;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <em class="jxr_javadoccomment">/**</em>
<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> SimpleLayout consists of the level of the log statement,</em>
<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> followed by " - " and then the log message itself. For example,</em>
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> &lt;pre&gt;</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> DEBUG - Hello world</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> &lt;/pre&gt;</em>
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> &lt;p&gt;</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> @author Ceki G&amp;uuml;lc&amp;uuml;</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> @since version 0.7.0</em>
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> &lt;p&gt;{@link PatternLayout} offers a much more powerful alternative.</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment">*/</em>
<a name="36" href="#36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/log4j/SimpleLayout.html">SimpleLayout</a> <strong class="jxr_keyword">extends</strong> <a href="../../../org/apache/log4j/Layout.html">Layout</a> {
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> StringBuffer sbuf = <strong class="jxr_keyword">new</strong> StringBuffer(128);
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/log4j/SimpleLayout.html">SimpleLayout</a>() {
<a name="41" href="#41">41</a> }
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong>
<a name="44" href="#44">44</a> <strong class="jxr_keyword">void</strong> activateOptions() {
<a name="45" href="#45">45</a> }
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> Returns the log statement in a format consisting of the</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> &lt;code&gt;level&lt;/code&gt;, followed by " - " and then the</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> &lt;code&gt;message&lt;/code&gt;. For example, &lt;pre&gt; INFO - "A message"</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> &lt;/pre&gt;</em>
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> &lt;p&gt;The &lt;code&gt;category&lt;/code&gt; parameter is ignored.</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> &lt;p&gt;</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> @return A byte array in SimpleLayout format.</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em>
<a name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong>
<a name="58" href="#58">58</a> String format(<a href="../../../org/apache/log4j/spi/LoggingEvent.html">LoggingEvent</a> event) {
<a name="59" href="#59">59</a>
<a name="60" href="#60">60</a> sbuf.setLength(0);
<a name="61" href="#61">61</a> sbuf.append(event.getLevel().toString());
<a name="62" href="#62">62</a> sbuf.append(<span class="jxr_string">" - "</span>);
<a name="63" href="#63">63</a> sbuf.append(event.getRenderedMessage());
<a name="64" href="#64">64</a> sbuf.append(LINE_SEP);
<a name="65" href="#65">65</a> <strong class="jxr_keyword">return</strong> sbuf.toString();
<a name="66" href="#66">66</a> }
<a name="67" href="#67">67</a>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> The SimpleLayout does not handle the throwable contained within</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> {@link LoggingEvent LoggingEvents}. Thus, it returns</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> &lt;code&gt;true&lt;/code&gt;.</em>
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> @since version 0.8.4 */</em>
<a name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong>
<a name="75" href="#75">75</a> <strong class="jxr_keyword">boolean</strong> ignoresThrowable() {
<a name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>