Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / log4j-1.2.17 / xref / org / apache / log4j / AppenderSkeleton.html
blob: f85847e8f4988ad6bd23acadbb9d856ec6c2e62f [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>AppenderSkeleton xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/apache/log4j/AppenderSkeleton.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.Filter;
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.ErrorHandler;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.OptionHandler;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.LoggingEvent;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.helpers.OnlyOnceErrorHandler;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.helpers.LogLog;
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * Abstract superclass of the other appenders in the package.</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * </em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * This class provides the code for common functionality, such as</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * support for threshold filtering and support for general filters.</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @since 0.8.1</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @author Ceki G&amp;uuml;lc&amp;uuml; </em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * */</em>
<a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/log4j/AppenderSkeleton.html">AppenderSkeleton</a> implements Appender, <a href="../../../org/apache/log4j/spi/OptionHandler.html">OptionHandler</a> {
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The layout variable does not need to be set if the appender</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> implementation has its own layout. */</em>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">protected</strong> <a href="../../../org/apache/log4j/Layout.html">Layout</a> layout;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Appenders are named. */</em>
<a name="44" href="#44">44</a> <strong class="jxr_keyword">protected</strong> String name;
<a name="45" href="#45">45</a>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> There is no level threshold filtering by default. */</em>
<a name="48" href="#48">48</a> <strong class="jxr_keyword">protected</strong> <a href="../../../org/apache/log4j/Priority.html">Priority</a> threshold;
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> It is assumed and enforced that errorHandler is never null.</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">protected</strong> <a href="../../../org/apache/log4j/spi/ErrorHandler.html">ErrorHandler</a> errorHandler = <strong class="jxr_keyword">new</strong> <a href="../../../org/apache/log4j/helpers/OnlyOnceErrorHandler.html">OnlyOnceErrorHandler</a>();
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The first filter in the filter chain. Set to &lt;code&gt;null&lt;/code&gt;</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> initially. */</em>
<a name="57" href="#57">57</a> <strong class="jxr_keyword">protected</strong> <a href="../../../org/apache/log4j/spi/Filter.html">Filter</a> headFilter;
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The last filter in the filter chain. */</em>
<a name="59" href="#59">59</a> <strong class="jxr_keyword">protected</strong> <a href="../../../org/apache/log4j/spi/Filter.html">Filter</a> tailFilter;
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> Is this appender closed? </em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
<a name="64" href="#64">64</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> closed = false;
<a name="65" href="#65">65</a>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Create new instance.</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/log4j/AppenderSkeleton.html">AppenderSkeleton</a>() {
<a name="70" href="#70">70</a> <strong class="jxr_keyword">super</strong>();
<a name="71" href="#71">71</a> }
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Create new instance.</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Provided for compatibility with log4j 1.3.</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> *</em>
<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * @param isActive true if appender is ready for use upon construction.</em>
<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Not used in log4j 1.2.x.</em>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @since 1.2.15</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
<a name="81" href="#81">81</a> <strong class="jxr_keyword">protected</strong> <a href="../../../org/apache/log4j/AppenderSkeleton.html">AppenderSkeleton</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isActive) {
<a name="82" href="#82">82</a> <strong class="jxr_keyword">super</strong>();
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment">/**</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> Derived appenders should override this method if option structure</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> requires it. */</em>
<a name="90" href="#90">90</a> <strong class="jxr_keyword">public</strong>
<a name="91" href="#91">91</a> <strong class="jxr_keyword">void</strong> activateOptions() {
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> Add a filter to end of the filter list.</em>
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> @since 0.9.0</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
<a name="100" href="#100">100</a> <strong class="jxr_keyword">public</strong>
<a name="101" href="#101">101</a> <strong class="jxr_keyword">void</strong> addFilter(<a href="../../../org/apache/log4j/spi/Filter.html">Filter</a> newFilter) {
<a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong>(headFilter == <strong class="jxr_keyword">null</strong>) {
<a name="103" href="#103">103</a> headFilter = tailFilter = newFilter;
<a name="104" href="#104">104</a> } <strong class="jxr_keyword">else</strong> {
<a name="105" href="#105">105</a> tailFilter.setNext(newFilter);
<a name="106" href="#106">106</a> tailFilter = newFilter;
<a name="107" href="#107">107</a> }
<a name="108" href="#108">108</a> }
<a name="109" href="#109">109</a>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> Subclasses of &lt;code&gt;AppenderSkeleton&lt;/code&gt; should implement this</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> method to perform actual logging. See also {@link #doAppend</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> AppenderSkeleton.doAppend} method.</em>
<a name="114" href="#114">114</a>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> @since 0.9.0</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
<a name="117" href="#117">117</a> <strong class="jxr_keyword">abstract</strong>
<a name="118" href="#118">118</a> <strong class="jxr_keyword">protected</strong>
<a name="119" href="#119">119</a> <strong class="jxr_keyword">void</strong> append(<a href="../../../org/apache/log4j/spi/LoggingEvent.html">LoggingEvent</a> event);
<a name="120" href="#120">120</a>
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> Clear the filters chain.</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> </em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> @since 0.9.0 */</em>
<a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong>
<a name="127" href="#127">127</a> <strong class="jxr_keyword">void</strong> clearFilters() {
<a name="128" href="#128">128</a> headFilter = tailFilter = <strong class="jxr_keyword">null</strong>;
<a name="129" href="#129">129</a> }
<a name="130" href="#130">130</a>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">/**</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> Finalize this appender by calling the derived class'</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> &lt;code&gt;close&lt;/code&gt; method.</em>
<a name="134" href="#134">134</a>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> @since 0.8.4 */</em>
<a name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong>
<a name="137" href="#137">137</a> <strong class="jxr_keyword">void</strong> finalize() {
<a name="138" href="#138">138</a> <em class="jxr_comment">// An appender might be closed then garbage collected. There is no</em>
<a name="139" href="#139">139</a> <em class="jxr_comment">// point in closing twice.</em>
<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong>(<strong class="jxr_keyword">this</strong>.closed)
<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong>;
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> LogLog.debug(<span class="jxr_string">"Finalizing appender named ["</span>+name+<span class="jxr_string">"]."</span>);
<a name="144" href="#144">144</a> close();
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a>
<a name="147" href="#147">147</a>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> Return the currently set {@link ErrorHandler} for this</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> Appender. </em>
<a name="151" href="#151">151</a>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> @since 0.9.0 */</em>
<a name="153" href="#153">153</a> <strong class="jxr_keyword">public</strong>
<a name="154" href="#154">154</a> <a href="../../../org/apache/log4j/spi/ErrorHandler.html">ErrorHandler</a> getErrorHandler() {
<a name="155" href="#155">155</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.errorHandler;
<a name="156" href="#156">156</a> }
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">/**</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> Returns the head Filter.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> </em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> @since 1.1</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em>
<a name="164" href="#164">164</a> <strong class="jxr_keyword">public</strong>
<a name="165" href="#165">165</a> <a href="../../../org/apache/log4j/spi/Filter.html">Filter</a> getFilter() {
<a name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> headFilter;
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> Return the first filter in the filter chain for this</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> Appender. The return value may be &lt;code&gt;null&lt;/code&gt; if no is</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> filter is set.</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> </em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> */</em>
<a name="175" href="#175">175</a> <strong class="jxr_keyword">public</strong>
<a name="176" href="#176">176</a> <strong class="jxr_keyword">final</strong>
<a name="177" href="#177">177</a> <a href="../../../org/apache/log4j/spi/Filter.html">Filter</a> getFirstFilter() {
<a name="178" href="#178">178</a> <strong class="jxr_keyword">return</strong> headFilter;
<a name="179" href="#179">179</a> }
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> Returns the layout of this appender. The value may be null.</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> */</em>
<a name="184" href="#184">184</a> <strong class="jxr_keyword">public</strong>
<a name="185" href="#185">185</a> <a href="../../../org/apache/log4j/Layout.html">Layout</a> getLayout() {
<a name="186" href="#186">186</a> <strong class="jxr_keyword">return</strong> layout;
<a name="187" href="#187">187</a> }
<a name="188" href="#188">188</a>
<a name="189" href="#189">189</a>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">/**</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> Returns the name of this appender.</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> @return name, may be null.</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> */</em>
<a name="194" href="#194">194</a> <strong class="jxr_keyword">public</strong>
<a name="195" href="#195">195</a> <strong class="jxr_keyword">final</strong>
<a name="196" href="#196">196</a> String getName() {
<a name="197" href="#197">197</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.name;
<a name="198" href="#198">198</a> }
<a name="199" href="#199">199</a>
<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">/**</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> Returns this appenders threshold level. See the {@link</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> #setThreshold} method for the meaning of this option.</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> </em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> @since 1.1 */</em>
<a name="205" href="#205">205</a> <strong class="jxr_keyword">public</strong>
<a name="206" href="#206">206</a> <a href="../../../org/apache/log4j/Priority.html">Priority</a> getThreshold() {
<a name="207" href="#207">207</a> <strong class="jxr_keyword">return</strong> threshold;
<a name="208" href="#208">208</a> }
<a name="209" href="#209">209</a>
<a name="210" href="#210">210</a>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">/**</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> Check whether the message level is below the appender's</em>
<a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> threshold. If there is no threshold set, then the return value is</em>
<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> always &lt;code&gt;true&lt;/code&gt;.</em>
<a name="215" href="#215">215</a>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> */</em>
<a name="217" href="#217">217</a> <strong class="jxr_keyword">public</strong>
<a name="218" href="#218">218</a> <strong class="jxr_keyword">boolean</strong> isAsSevereAsThreshold(<a href="../../../org/apache/log4j/Priority.html">Priority</a> priority) {
<a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> ((threshold == <strong class="jxr_keyword">null</strong>) || priority.isGreaterOrEqual(threshold));
<a name="220" href="#220">220</a> }
<a name="221" href="#221">221</a>
<a name="222" href="#222">222</a>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">/**</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * This method performs threshold checks and invokes filters before</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * delegating actual logging to the subclasses specific {@link</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * AppenderSkeleton#append} method.</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * */</em>
<a name="228" href="#228">228</a> <strong class="jxr_keyword">public</strong>
<a name="229" href="#229">229</a> <strong class="jxr_keyword">synchronized</strong>
<a name="230" href="#230">230</a> <strong class="jxr_keyword">void</strong> doAppend(<a href="../../../org/apache/log4j/spi/LoggingEvent.html">LoggingEvent</a> event) {
<a name="231" href="#231">231</a> <strong class="jxr_keyword">if</strong>(closed) {
<a name="232" href="#232">232</a> LogLog.error(<span class="jxr_string">"Attempted to append to closed appender named ["</span>+name+<span class="jxr_string">"]."</span>);
<a name="233" href="#233">233</a> <strong class="jxr_keyword">return</strong>;
<a name="234" href="#234">234</a> }
<a name="235" href="#235">235</a>
<a name="236" href="#236">236</a> <strong class="jxr_keyword">if</strong>(!isAsSevereAsThreshold(event.getLevel())) {
<a name="237" href="#237">237</a> <strong class="jxr_keyword">return</strong>;
<a name="238" href="#238">238</a> }
<a name="239" href="#239">239</a>
<a name="240" href="#240">240</a> <a href="../../../org/apache/log4j/spi/Filter.html">Filter</a> f = <strong class="jxr_keyword">this</strong>.headFilter;
<a name="241" href="#241">241</a>
<a name="242" href="#242">242</a> FILTER_LOOP:
<a name="243" href="#243">243</a> <strong class="jxr_keyword">while</strong>(f != <strong class="jxr_keyword">null</strong>) {
<a name="244" href="#244">244</a> <strong class="jxr_keyword">switch</strong>(f.decide(event)) {
<a name="245" href="#245">245</a> <strong class="jxr_keyword">case</strong> Filter.DENY: <strong class="jxr_keyword">return</strong>;
<a name="246" href="#246">246</a> <strong class="jxr_keyword">case</strong> Filter.ACCEPT: <strong class="jxr_keyword">break</strong> FILTER_LOOP;
<a name="247" href="#247">247</a> <strong class="jxr_keyword">case</strong> Filter.NEUTRAL: f = f.getNext();
<a name="248" href="#248">248</a> }
<a name="249" href="#249">249</a> }
<a name="250" href="#250">250</a>
<a name="251" href="#251">251</a> <strong class="jxr_keyword">this</strong>.append(event);
<a name="252" href="#252">252</a> }
<a name="253" href="#253">253</a>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> Set the {@link ErrorHandler} for this Appender.</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> @since 0.9.0</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> */</em>
<a name="258" href="#258">258</a> <strong class="jxr_keyword">public</strong>
<a name="259" href="#259">259</a> <strong class="jxr_keyword">synchronized</strong>
<a name="260" href="#260">260</a> <strong class="jxr_keyword">void</strong> setErrorHandler(<a href="../../../org/apache/log4j/spi/ErrorHandler.html">ErrorHandler</a> eh) {
<a name="261" href="#261">261</a> <strong class="jxr_keyword">if</strong>(eh == <strong class="jxr_keyword">null</strong>) {
<a name="262" href="#262">262</a> <em class="jxr_comment">// We do not throw exception here since the cause is probably a</em>
<a name="263" href="#263">263</a> <em class="jxr_comment">// bad config file.</em>
<a name="264" href="#264">264</a> LogLog.warn(<span class="jxr_string">"You have tried to set a null error-handler."</span>);
<a name="265" href="#265">265</a> } <strong class="jxr_keyword">else</strong> {
<a name="266" href="#266">266</a> <strong class="jxr_keyword">this</strong>.errorHandler = eh;
<a name="267" href="#267">267</a> }
<a name="268" href="#268">268</a> }
<a name="269" href="#269">269</a>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">/**</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> Set the layout for this appender. Note that some appenders have</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> their own (fixed) layouts or do not use one. For example, the</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> {@link org.apache.log4j.net.SocketAppender} ignores the layout set</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> here. </em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> */</em>
<a name="276" href="#276">276</a> <strong class="jxr_keyword">public</strong>
<a name="277" href="#277">277</a> <strong class="jxr_keyword">void</strong> setLayout(<a href="../../../org/apache/log4j/Layout.html">Layout</a> layout) {
<a name="278" href="#278">278</a> <strong class="jxr_keyword">this</strong>.layout = layout;
<a name="279" href="#279">279</a> }
<a name="280" href="#280">280</a>
<a name="281" href="#281">281</a>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">/**</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> Set the name of this Appender.</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> */</em>
<a name="285" href="#285">285</a> <strong class="jxr_keyword">public</strong>
<a name="286" href="#286">286</a> <strong class="jxr_keyword">void</strong> setName(String name) {
<a name="287" href="#287">287</a> <strong class="jxr_keyword">this</strong>.name = name;
<a name="288" href="#288">288</a> }
<a name="289" href="#289">289</a>
<a name="290" href="#290">290</a>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">/**</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment"> Set the threshold level. All log events with lower level</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment"> than the threshold level are ignored by the appender.</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment"> </em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> &lt;p&gt;In configuration files this option is specified by setting the</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> value of the &lt;b&gt;Threshold&lt;/b&gt; option to a level</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> string, such as "DEBUG", "INFO" and so on.</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> </em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> @since 0.8.3 */</em>
<a name="300" href="#300">300</a> <strong class="jxr_keyword">public</strong>
<a name="301" href="#301">301</a> <strong class="jxr_keyword">void</strong> setThreshold(<a href="../../../org/apache/log4j/Priority.html">Priority</a> threshold) {
<a name="302" href="#302">302</a> <strong class="jxr_keyword">this</strong>.threshold = threshold;
<a name="303" href="#303">303</a> }
<a name="304" href="#304">304</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>