You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@logging.apache.org by ca...@apache.org on 2007/07/21 19:21:03 UTC
svn commit: r558355 [23/25] - in
/logging/site/trunk/docs/log4j/companions/component: ./ apidocs/
apidocs/org/ apidocs/org/apache/ apidocs/org/apache/log4j/
apidocs/org/apache/log4j/class-use/ apidocs/org/apache/log4j/helpers/
apidocs/org/apache/log4j/...
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Scheduler.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Scheduler.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Scheduler.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Scheduler.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,320 @@
+<!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>Scheduler xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/scheduler/Scheduler.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="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="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a>
+<a name="18" href="#18">18</a> <strong>package</strong> org.apache.log4j.scheduler;
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a> <strong>import</strong> java.util.List;
+<a name="21" href="#21">21</a> <strong>import</strong> java.util.Vector;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <em>/**<em>*</em></em>
+<a name="24" href="#24">24</a> <em> * A simple but still useful implementation of a Scheduler (in memory only).</em>
+<a name="25" href="#25">25</a> <em> * <p/></em>
+<a name="26" href="#26">26</a> <em> * This implementation will work very well when the number of scheduled job is</em>
+<a name="27" href="#27">27</a> <em> * small, say less than 100 jobs. If a larger number of events need to be</em>
+<a name="28" href="#28">28</a> <em> * scheduled, than a better adapted data structure for the jobList can give</em>
+<a name="29" href="#29">29</a> <em> * improved performance.</em>
+<a name="30" href="#30">30</a> <em> *</em>
+<a name="31" href="#31">31</a> <em> * @author Ceki</em>
+<a name="32" href="#32">32</a> <em> */</em>
+<a name="33" href="#33">33</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/scheduler/Scheduler.html">Scheduler</a> <strong>extends</strong> Thread {
+<a name="34" href="#34">34</a>
+<a name="35" href="#35">35</a> <em>/**<em>*</em></em>
+<a name="36" href="#36">36</a> <em> * Job list.</em>
+<a name="37" href="#37">37</a> <em> */</em>
+<a name="38" href="#38">38</a> List jobList;
+<a name="39" href="#39">39</a> <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a> <em> * If set true, scheduler has or should shut down.</em>
+<a name="41" href="#41">41</a> <em> */</em>
+<a name="42" href="#42">42</a> <strong>boolean</strong> shutdown = false;
+<a name="43" href="#43">43</a>
+<a name="44" href="#44">44</a> <em>/**<em>*</em></em>
+<a name="45" href="#45">45</a> <em> * Create new instance.</em>
+<a name="46" href="#46">46</a> <em> */</em>
+<a name="47" href="#47">47</a> <strong>public</strong> <a href="../../../../org/apache/log4j/scheduler/Scheduler.html">Scheduler</a>() {
+<a name="48" href="#48">48</a> <strong>super</strong>();
+<a name="49" href="#49">49</a> jobList = <strong>new</strong> Vector();
+<a name="50" href="#50">50</a> }
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <em>/**<em>*</em></em>
+<a name="53" href="#53">53</a> <em> * Find the index of a given job.</em>
+<a name="54" href="#54">54</a> <em> * @param job job</em>
+<a name="55" href="#55">55</a> <em> * @return -1 if the job could not be found.</em>
+<a name="56" href="#56">56</a> <em> */</em>
+<a name="57" href="#57">57</a> <strong>int</strong> findIndex(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job) {
+<a name="58" href="#58">58</a> <strong>int</strong> size = jobList.size();
+<a name="59" href="#59">59</a> <strong>boolean</strong> found = false;
+<a name="60" href="#60">60</a>
+<a name="61" href="#61">61</a> <strong>int</strong> i = 0;
+<a name="62" href="#62">62</a> <strong>for</strong> (; i < size; i++) {
+<a name="63" href="#63">63</a> ScheduledJobEntry se = (ScheduledJobEntry) jobList.get(i);
+<a name="64" href="#64">64</a> <strong>if</strong> (se.job == job) {
+<a name="65" href="#65">65</a> found = <strong>true</strong>;
+<a name="66" href="#66">66</a> <strong>break</strong>;
+<a name="67" href="#67">67</a> }
+<a name="68" href="#68">68</a> }
+<a name="69" href="#69">69</a> <strong>if</strong> (found) {
+<a name="70" href="#70">70</a> <strong>return</strong> i;
+<a name="71" href="#71">71</a> } <strong>else</strong> {
+<a name="72" href="#72">72</a> <strong>return</strong> -1;
+<a name="73" href="#73">73</a> }
+<a name="74" href="#74">74</a> }
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> <em>/**<em>*</em></em>
+<a name="77" href="#77">77</a> <em> * Delete the given job.</em>
+<a name="78" href="#78">78</a> <em> * @param job job.</em>
+<a name="79" href="#79">79</a> <em> * @return true if the job could be deleted, and</em>
+<a name="80" href="#80">80</a> <em> * false if the job could not be found or if the Scheduler is about to</em>
+<a name="81" href="#81">81</a> <em> * shutdown in which case deletions are not permitted.</em>
+<a name="82" href="#82">82</a> <em> */</em>
+<a name="83" href="#83">83</a> <strong>public</strong> <strong>synchronized</strong> <strong>boolean</strong> delete(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job) {
+<a name="84" href="#84">84</a> <em class="comment">// if already shutdown in the process of shutdown, there is no</em>
+<a name="85" href="#85">85</a> <em class="comment">// need to remove Jobs as they will never be executed.</em>
+<a name="86" href="#86">86</a> <strong>if</strong> (shutdown) {
+<a name="87" href="#87">87</a> <strong>return</strong> false;
+<a name="88" href="#88">88</a> }
+<a name="89" href="#89">89</a> <strong>int</strong> i = findIndex(job);
+<a name="90" href="#90">90</a> <strong>if</strong> (i != -1) {
+<a name="91" href="#91">91</a> ScheduledJobEntry se = (ScheduledJobEntry) jobList.remove(i);
+<a name="92" href="#92">92</a> <strong>if</strong> (se.job != job) { <em class="comment">// this should never happen</em>
+<a name="93" href="#93">93</a> <strong>new</strong> IllegalStateException(<span class="string">"Internal programming error"</span>);
+<a name="94" href="#94">94</a> }
+<a name="95" href="#95">95</a> <em class="comment">// if the job is the first on the list,</em>
+<a name="96" href="#96">96</a> <em class="comment">// then notify the scheduler thread to schedule a new job</em>
+<a name="97" href="#97">97</a> <strong>if</strong> (i == 0) {
+<a name="98" href="#98">98</a> <strong>this</strong>.notifyAll();
+<a name="99" href="#99">99</a> }
+<a name="100" href="#100">100</a> <strong>return</strong> <strong>true</strong>;
+<a name="101" href="#101">101</a> } <strong>else</strong> {
+<a name="102" href="#102">102</a> <strong>return</strong> false;
+<a name="103" href="#103">103</a> }
+<a name="104" href="#104">104</a> }
+<a name="105" href="#105">105</a>
+<a name="106" href="#106">106</a>
+<a name="107" href="#107">107</a> <em>/**<em>*</em></em>
+<a name="108" href="#108">108</a> <em> * Schedule a {@link Job} for execution at system time given by</em>
+<a name="109" href="#109">109</a> <em> * the <code>desiredTime</code> parameter.</em>
+<a name="110" href="#110">110</a> <em> * @param job job to schedule.</em>
+<a name="111" href="#111">111</a> <em> * @param desiredTime desired time of execution.</em>
+<a name="112" href="#112">112</a> <em> */</em>
+<a name="113" href="#113">113</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> schedule(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job,
+<a name="114" href="#114">114</a> <strong>final</strong> <strong>long</strong> desiredTime) {
+<a name="115" href="#115">115</a> schedule(<strong>new</strong> ScheduledJobEntry(job, desiredTime));
+<a name="116" href="#116">116</a> }
+<a name="117" href="#117">117</a>
+<a name="118" href="#118">118</a> <em>/**<em>*</em></em>
+<a name="119" href="#119">119</a> <em> * Schedule a {@link Job} for execution at system time given by</em>
+<a name="120" href="#120">120</a> <em> * the <code>desiredTime</code> parameter.</em>
+<a name="121" href="#121">121</a> <em> * <p/></em>
+<a name="122" href="#122">122</a> <em> * The job will be rescheduled. It will execute with a frequency determined</em>
+<a name="123" href="#123">123</a> <em> * by the period parameter.</em>
+<a name="124" href="#124">124</a> <em> * @param job job to schedule.</em>
+<a name="125" href="#125">125</a> <em> * @param desiredTime desired time of execution.</em>
+<a name="126" href="#126">126</a> <em> * @param period repeat period.</em>
+<a name="127" href="#127">127</a> <em> */</em>
+<a name="128" href="#128">128</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> schedule(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job,
+<a name="129" href="#129">129</a> <strong>final</strong> <strong>long</strong> desiredTime,
+<a name="130" href="#130">130</a> <strong>final</strong> <strong>long</strong> period) {
+<a name="131" href="#131">131</a> schedule(<strong>new</strong> ScheduledJobEntry(job, desiredTime, period));
+<a name="132" href="#132">132</a> }
+<a name="133" href="#133">133</a>
+<a name="134" href="#134">134</a> <em>/**<em>*</em></em>
+<a name="135" href="#135">135</a> <em> * Change the period of a job. The original job must exist for its period</em>
+<a name="136" href="#136">136</a> <em> * to be changed.</em>
+<a name="137" href="#137">137</a> <em> * <p/></em>
+<a name="138" href="#138">138</a> <em> * The method returns true if the period could be changed, and false</em>
+<a name="139" href="#139">139</a> <em> * otherwise.</em>
+<a name="140" href="#140">140</a> <em> * @param job job.</em>
+<a name="141" href="#141">141</a> <em> * @param newPeriod new repeat period.</em>
+<a name="142" href="#142">142</a> <em> * @return true if period could be changed.</em>
+<a name="143" href="#143">143</a> <em> */</em>
+<a name="144" href="#144">144</a> <strong>public</strong> <strong>synchronized</strong> <strong>boolean</strong> changePeriod(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job,
+<a name="145" href="#145">145</a> <strong>final</strong> <strong>long</strong> newPeriod) {
+<a name="146" href="#146">146</a> <strong>if</strong> (newPeriod <= 0) {
+<a name="147" href="#147">147</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(
+<a name="148" href="#148">148</a> <span class="string">"Period must be an integer langer than zero"</span>);
+<a name="149" href="#149">149</a> }
+<a name="150" href="#150">150</a>
+<a name="151" href="#151">151</a> <strong>int</strong> i = findIndex(job);
+<a name="152" href="#152">152</a> <strong>if</strong> (i == -1) {
+<a name="153" href="#153">153</a> <strong>return</strong> false;
+<a name="154" href="#154">154</a> } <strong>else</strong> {
+<a name="155" href="#155">155</a> ScheduledJobEntry se = (ScheduledJobEntry) jobList.get(i);
+<a name="156" href="#156">156</a> se.period = newPeriod;
+<a name="157" href="#157">157</a> <strong>return</strong> <strong>true</strong>;
+<a name="158" href="#158">158</a> }
+<a name="159" href="#159">159</a> }
+<a name="160" href="#160">160</a>
+<a name="161" href="#161">161</a> <em>/**<em>*</em></em>
+<a name="162" href="#162">162</a> <em> * Schedule a job.</em>
+<a name="163" href="#163">163</a> <em> * @param newSJE new job entry.</em>
+<a name="164" href="#164">164</a> <em> */</em>
+<a name="165" href="#165">165</a> <strong>private</strong> <strong>synchronized</strong> <strong>void</strong> schedule(<strong>final</strong> ScheduledJobEntry newSJE) {
+<a name="166" href="#166">166</a> <em class="comment">// disallow new jobs after shutdown</em>
+<a name="167" href="#167">167</a> <strong>if</strong> (shutdown) {
+<a name="168" href="#168">168</a> <strong>return</strong>;
+<a name="169" href="#169">169</a> }
+<a name="170" href="#170">170</a> <strong>int</strong> max = jobList.size();
+<a name="171" href="#171">171</a> <strong>long</strong> desiredExecutionTime = newSJE.desiredExecutionTime;
+<a name="172" href="#172">172</a>
+<a name="173" href="#173">173</a> <em class="comment">// find the index i such that timeInMillis < jobList[i]</em>
+<a name="174" href="#174">174</a> <strong>int</strong> i = 0;
+<a name="175" href="#175">175</a> <strong>for</strong> (; i < max; i++) {
+<a name="176" href="#176">176</a>
+<a name="177" href="#177">177</a> ScheduledJobEntry sje = (ScheduledJobEntry) jobList.get(i);
+<a name="178" href="#178">178</a>
+<a name="179" href="#179">179</a> <strong>if</strong> (desiredExecutionTime < sje.desiredExecutionTime) {
+<a name="180" href="#180">180</a> <strong>break</strong>;
+<a name="181" href="#181">181</a> }
+<a name="182" href="#182">182</a> }
+<a name="183" href="#183">183</a> jobList.add(i, newSJE);
+<a name="184" href="#184">184</a> <em class="comment">// if the jobList was empty, then notify the scheduler thread</em>
+<a name="185" href="#185">185</a> <strong>if</strong> (i == 0) {
+<a name="186" href="#186">186</a> <strong>this</strong>.notifyAll();
+<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>/**<em>*</em></em>
+<a name="191" href="#191">191</a> <em> * Shut down scheduler.</em>
+<a name="192" href="#192">192</a> <em> */</em>
+<a name="193" href="#193">193</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> shutdown() {
+<a name="194" href="#194">194</a> shutdown = <strong>true</strong>;
+<a name="195" href="#195">195</a> }
+<a name="196" href="#196">196</a>
+<a name="197" href="#197">197</a> <em>/**<em>*</em></em>
+<a name="198" href="#198">198</a> <em> * Run scheduler.</em>
+<a name="199" href="#199">199</a> <em> */</em>
+<a name="200" href="#200">200</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> run() {
+<a name="201" href="#201">201</a> <strong>while</strong> (!shutdown) {
+<a name="202" href="#202">202</a> <strong>if</strong> (jobList.isEmpty()) {
+<a name="203" href="#203">203</a> linger();
+<a name="204" href="#204">204</a> } <strong>else</strong> {
+<a name="205" href="#205">205</a> ScheduledJobEntry sje = (ScheduledJobEntry) jobList.get(0);
+<a name="206" href="#206">206</a> <strong>long</strong> now = System.currentTimeMillis();
+<a name="207" href="#207">207</a> <strong>if</strong> (now >= sje.desiredExecutionTime) {
+<a name="208" href="#208">208</a> executeInABox(sje.job);
+<a name="209" href="#209">209</a> jobList.remove(0);
+<a name="210" href="#210">210</a> <strong>if</strong> (sje.period > 0) {
+<a name="211" href="#211">211</a> sje.desiredExecutionTime = now + sje.period;
+<a name="212" href="#212">212</a> schedule(sje);
+<a name="213" href="#213">213</a> }
+<a name="214" href="#214">214</a> } <strong>else</strong> {
+<a name="215" href="#215">215</a> linger(sje.desiredExecutionTime - now);
+<a name="216" href="#216">216</a> }
+<a name="217" href="#217">217</a> }
+<a name="218" href="#218">218</a> }
+<a name="219" href="#219">219</a> <em class="comment">// clear out the job list to facilitate garbage collection</em>
+<a name="220" href="#220">220</a> jobList.clear();
+<a name="221" href="#221">221</a> jobList = <strong>null</strong>;
+<a name="222" href="#222">222</a> System.out.println(<span class="string">"Leaving scheduler run method"</span>);
+<a name="223" href="#223">223</a> }
+<a name="224" href="#224">224</a>
+<a name="225" href="#225">225</a> <em>/**<em>*</em></em>
+<a name="226" href="#226">226</a> <em> * We do not want a single failure to affect the whole scheduler.</em>
+<a name="227" href="#227">227</a> <em> * @param job job to execute.</em>
+<a name="228" href="#228">228</a> <em> */</em>
+<a name="229" href="#229">229</a> <strong>void</strong> executeInABox(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job) {
+<a name="230" href="#230">230</a> <strong>try</strong> {
+<a name="231" href="#231">231</a> job.execute();
+<a name="232" href="#232">232</a> } <strong>catch</strong> (Exception e) {
+<a name="233" href="#233">233</a> System.err.println(<span class="string">"The execution of the job threw an exception"</span>);
+<a name="234" href="#234">234</a> e.printStackTrace(System.err);
+<a name="235" href="#235">235</a> }
+<a name="236" href="#236">236</a> }
+<a name="237" href="#237">237</a>
+<a name="238" href="#238">238</a> <em>/**<em>*</em></em>
+<a name="239" href="#239">239</a> <em> * Wait for notification.</em>
+<a name="240" href="#240">240</a> <em> */</em>
+<a name="241" href="#241">241</a> <strong>void</strong> linger() {
+<a name="242" href="#242">242</a> <strong>try</strong> {
+<a name="243" href="#243">243</a> <strong>while</strong> (jobList.isEmpty() && !shutdown) {
+<a name="244" href="#244">244</a> <strong>this</strong>.wait();
+<a name="245" href="#245">245</a> }
+<a name="246" href="#246">246</a> } <strong>catch</strong> (InterruptedException ie) {
+<a name="247" href="#247">247</a> shutdown = <strong>true</strong>;
+<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> <em>/**<em>*</em></em>
+<a name="252" href="#252">252</a> <em> * Wait for notification or time to elapse.</em>
+<a name="253" href="#253">253</a> <em> * @param timeToLinger time to linger.</em>
+<a name="254" href="#254">254</a> <em> */</em>
+<a name="255" href="#255">255</a> <strong>void</strong> linger(<strong>final</strong> <strong>long</strong> timeToLinger) {
+<a name="256" href="#256">256</a> <strong>try</strong> {
+<a name="257" href="#257">257</a> <strong>this</strong>.wait(timeToLinger);
+<a name="258" href="#258">258</a> } <strong>catch</strong> (InterruptedException ie) {
+<a name="259" href="#259">259</a> shutdown = <strong>true</strong>;
+<a name="260" href="#260">260</a> }
+<a name="261" href="#261">261</a> }
+<a name="262" href="#262">262</a>
+<a name="263" href="#263">263</a> <em>/**<em>*</em></em>
+<a name="264" href="#264">264</a> <em> * Represents an entry in job scheduler.</em>
+<a name="265" href="#265">265</a> <em> */</em>
+<a name="266" href="#266">266</a> <strong>static</strong> <strong>final</strong> <strong>class</strong> ScheduledJobEntry {
+<a name="267" href="#267">267</a> <em>/**<em>*</em></em>
+<a name="268" href="#268">268</a> <em> * Desired execution time.</em>
+<a name="269" href="#269">269</a> <em> */</em>
+<a name="270" href="#270">270</a> <strong>long</strong> desiredExecutionTime;
+<a name="271" href="#271">271</a> <em>/**<em>*</em></em>
+<a name="272" href="#272">272</a> <em> * Job to run.</em>
+<a name="273" href="#273">273</a> <em> */</em>
+<a name="274" href="#274">274</a> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job;
+<a name="275" href="#275">275</a> <em>/**<em>*</em></em>
+<a name="276" href="#276">276</a> <em> * Repeat period.</em>
+<a name="277" href="#277">277</a> <em> */</em>
+<a name="278" href="#278">278</a> <strong>long</strong> period = 0;
+<a name="279" href="#279">279</a>
+<a name="280" href="#280">280</a> <em>/**<em>*</em></em>
+<a name="281" href="#281">281</a> <em> * Create new instance.</em>
+<a name="282" href="#282">282</a> <em> * @param job job</em>
+<a name="283" href="#283">283</a> <em> * @param desiredTime desired time.</em>
+<a name="284" href="#284">284</a> <em> */</em>
+<a name="285" href="#285">285</a> ScheduledJobEntry(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job, <strong>final</strong> <strong>long</strong> desiredTime) {
+<a name="286" href="#286">286</a> <strong>this</strong>(job, desiredTime, 0);
+<a name="287" href="#287">287</a> }
+<a name="288" href="#288">288</a>
+<a name="289" href="#289">289</a> <em>/**<em>*</em></em>
+<a name="290" href="#290">290</a> <em> * Create new instance.</em>
+<a name="291" href="#291">291</a> <em> * @param job job</em>
+<a name="292" href="#292">292</a> <em> * @param desiredTime desired time</em>
+<a name="293" href="#293">293</a> <em> * @param period repeat period</em>
+<a name="294" href="#294">294</a> <em> */</em>
+<a name="295" href="#295">295</a> ScheduledJobEntry(<strong>final</strong> <a href="../../../../org/apache/log4j/scheduler/Job.html">Job</a> job,
+<a name="296" href="#296">296</a> <strong>final</strong> <strong>long</strong> desiredTime,
+<a name="297" href="#297">297</a> <strong>final</strong> <strong>long</strong> period) {
+<a name="298" href="#298">298</a> <strong>super</strong>();
+<a name="299" href="#299">299</a> <strong>this</strong>.desiredExecutionTime = desiredTime;
+<a name="300" href="#300">300</a> <strong>this</strong>.job = job;
+<a name="301" href="#301">301</a> <strong>this</strong>.period = period;
+<a name="302" href="#302">302</a> }
+<a name="303" href="#303">303</a> }
+<a name="304" href="#304">304</a>
+<a name="305" href="#305">305</a> }
+<a name="306" href="#306">306</a>
+<a name="307" href="#307">307</a>
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Scheduler.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-frame.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-frame.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-frame.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-frame.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,27 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Apache Component Companion for log4j 1.2. 1.0-SNAPSHOT Reference Package org.apache.log4j.scheduler</title>
+ <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">org.apache.log4j.scheduler</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="Job.html" target="classFrame">Job</a>
+ </li>
+ <li>
+ <a href="Scheduler.html" target="classFrame">Scheduler</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-frame.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-summary.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-summary.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-summary.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-summary.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,72 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Apache Component Companion for log4j 1.2. 1.0-SNAPSHOT Reference Package $name</title>
+ <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package org.apache.log4j.scheduler</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="Job.html" target="classFrame">Job</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="Scheduler.html" target="classFrame">Scheduler</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © null Apache Software Foundation. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/package-summary.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Component.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Component.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Component.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Component.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,51 @@
+<!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>Component xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/spi/Component.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="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="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a> <strong>package</strong> org.apache.log4j.spi;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a> <em>/**<em>*</em></em>
+<a name="21" href="#21">21</a> <em> * A common interface shared by log4j components.</em>
+<a name="22" href="#22">22</a> <em> *</em>
+<a name="23" href="#23">23</a> <em> * @author Ceki Gulcu</em>
+<a name="24" href="#24">24</a> <em> * @since 1.3</em>
+<a name="25" href="#25">25</a> <em> */</em>
+<a name="26" href="#26">26</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/spi/Component.html">Component</a> {
+<a name="27" href="#27">27</a>
+<a name="28" href="#28">28</a>
+<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
+<a name="30" href="#30">30</a> <em> * Set owning logger repository for this component. This operation can</em>
+<a name="31" href="#31">31</a> <em> * only be performed once.</em>
+<a name="32" href="#32">32</a> <em> * Once set, a subsequent attempt will throw an IllegalStateException.</em>
+<a name="33" href="#33">33</a> <em> *</em>
+<a name="34" href="#34">34</a> <em> * @param repository The repository where this appender is attached.</em>
+<a name="35" href="#35">35</a> <em> */</em>
+<a name="36" href="#36">36</a> <strong>void</strong> setLoggerRepository(LoggerRepository repository);
+<a name="37" href="#37">37</a>
+<a name="38" href="#38">38</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Component.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ComponentBase.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ComponentBase.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ComponentBase.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ComponentBase.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,140 @@
+<!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>ComponentBase xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/spi/ComponentBase.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="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="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a> <strong>package</strong> org.apache.log4j.spi;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a> <strong>import</strong> org.apache.log4j.ULogger;
+<a name="20" href="#20">20</a> <strong>import</strong> org.apache.log4j.Logger;
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <em>/**<em>*</em></em>
+<a name="24" href="#24">24</a> <em> * Most log4j components derive from this class.</em>
+<a name="25" href="#25">25</a> <em> *</em>
+<a name="26" href="#26">26</a> <em> * @author Ceki Gulcu</em>
+<a name="27" href="#27">27</a> <em> * @since 1.3</em>
+<a name="28" href="#28">28</a> <em> */</em>
+<a name="29" href="#29">29</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/spi/ComponentBase.html">ComponentBase</a> implements <a href="../../../../org/apache/log4j/spi/Component.html">Component</a> {
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <em>/**<em>*</em></em>
+<a name="32" href="#32">32</a> <em> * Error count limit.</em>
+<a name="33" href="#33">33</a> <em> */</em>
+<a name="34" href="#34">34</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> ERROR_COUNT_LIMIT = 3;
+<a name="35" href="#35">35</a>
+<a name="36" href="#36">36</a> <em>/**<em>*</em></em>
+<a name="37" href="#37">37</a> <em> * Logger repository.</em>
+<a name="38" href="#38">38</a> <em> */</em>
+<a name="39" href="#39">39</a> <strong>protected</strong> LoggerRepository repository;
+<a name="40" href="#40">40</a> <em>/**<em>*</em></em>
+<a name="41" href="#41">41</a> <em> * Logger.</em>
+<a name="42" href="#42">42</a> <em> */</em>
+<a name="43" href="#43">43</a> <strong>private</strong> <a href="../../../../org/apache/log4j/ULogger.html">ULogger</a> logger;
+<a name="44" href="#44">44</a> <em>/**<em>*</em></em>
+<a name="45" href="#45">45</a> <em> * Error count.</em>
+<a name="46" href="#46">46</a> <em> */</em>
+<a name="47" href="#47">47</a> <strong>private</strong> <strong>int</strong> errorCount = 0;
+<a name="48" href="#48">48</a>
+<a name="49" href="#49">49</a> <em>/**<em>*</em></em>
+<a name="50" href="#50">50</a> <em> * Construct a new instance.</em>
+<a name="51" href="#51">51</a> <em> */</em>
+<a name="52" href="#52">52</a> <strong>protected</strong> <a href="../../../../org/apache/log4j/spi/ComponentBase.html">ComponentBase</a>() {
+<a name="53" href="#53">53</a> <strong>super</strong>();
+<a name="54" href="#54">54</a> }
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</a>
+<a name="57" href="#57">57</a> <em>/**<em>*</em></em>
+<a name="58" href="#58">58</a> <em> * Called by derived classes when they deem that the component has recovered</em>
+<a name="59" href="#59">59</a> <em> * from an erroneous state.</em>
+<a name="60" href="#60">60</a> <em> */</em>
+<a name="61" href="#61">61</a> <strong>protected</strong> <strong>void</strong> resetErrorCount() {
+<a name="62" href="#62">62</a> errorCount = 0;
+<a name="63" href="#63">63</a> }
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <em>/**<em>*</em></em>
+<a name="66" href="#66">66</a> <em> * Set the owning repository. The owning repository cannot be set more than</em>
+<a name="67" href="#67">67</a> <em> * once.</em>
+<a name="68" href="#68">68</a> <em> *</em>
+<a name="69" href="#69">69</a> <em> * @param repository repository</em>
+<a name="70" href="#70">70</a> <em> */</em>
+<a name="71" href="#71">71</a> <strong>public</strong> <strong>void</strong> setLoggerRepository(<strong>final</strong> LoggerRepository repository) {
+<a name="72" href="#72">72</a> <strong>if</strong> (<strong>this</strong>.repository == <strong>null</strong>) {
+<a name="73" href="#73">73</a> <strong>this</strong>.repository = repository;
+<a name="74" href="#74">74</a> } <strong>else</strong> <strong>if</strong> (<strong>this</strong>.repository != repository) {
+<a name="75" href="#75">75</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Repository has been already set"</span>);
+<a name="76" href="#76">76</a> }
+<a name="77" href="#77">77</a> }
+<a name="78" href="#78">78</a>
+<a name="79" href="#79">79</a> <em>/**<em>*</em></em>
+<a name="80" href="#80">80</a> <em> * Return the LoggerRepository to which this component is attached.</em>
+<a name="81" href="#81">81</a> <em> *</em>
+<a name="82" href="#82">82</a> <em> * @return Owning LoggerRepository</em>
+<a name="83" href="#83">83</a> <em> */</em>
+<a name="84" href="#84">84</a> <strong>protected</strong> LoggerRepository getLoggerRepository() {
+<a name="85" href="#85">85</a> <strong>return</strong> repository;
+<a name="86" href="#86">86</a> }
+<a name="87" href="#87">87</a>
+<a name="88" href="#88">88</a> <em>/**<em>*</em></em>
+<a name="89" href="#89">89</a> <em> * Return an instance specific logger to be used by the component itself.</em>
+<a name="90" href="#90">90</a> <em> * This logger is not intended to be accessed by the end-user, hence the</em>
+<a name="91" href="#91">91</a> <em> * protected keyword.</em>
+<a name="92" href="#92">92</a> <em> * <p/></em>
+<a name="93" href="#93">93</a> <em> * <p>In case the repository for this component is not set,</em>
+<a name="94" href="#94">94</a> <em> * this implementations returns a {@link SimpleULogger} instance.</em>
+<a name="95" href="#95">95</a> <em> *</em>
+<a name="96" href="#96">96</a> <em> * @return A ULogger instance.</em>
+<a name="97" href="#97">97</a> <em> */</em>
+<a name="98" href="#98">98</a> <strong>protected</strong> <a href="../../../../org/apache/log4j/ULogger.html">ULogger</a> getLogger() {
+<a name="99" href="#99">99</a> <strong>if</strong> (logger == <strong>null</strong>) {
+<a name="100" href="#100">100</a> <strong>if</strong> (repository != <strong>null</strong>) {
+<a name="101" href="#101">101</a> Logger l = repository.getLogger(<strong>this</strong>.getClass().getName());
+<a name="102" href="#102">102</a> <strong>if</strong> (l instanceof ULogger) {
+<a name="103" href="#103">103</a> logger = (ULogger) l;
+<a name="104" href="#104">104</a> } <strong>else</strong> {
+<a name="105" href="#105">105</a> logger = <strong>new</strong> Log4JULogger(l);
+<a name="106" href="#106">106</a> }
+<a name="107" href="#107">107</a> } <strong>else</strong> {
+<a name="108" href="#108">108</a> logger = SimpleULogger.getLogger(<strong>this</strong>.getClass().getName());
+<a name="109" href="#109">109</a> }
+<a name="110" href="#110">110</a> }
+<a name="111" href="#111">111</a> <strong>return</strong> logger;
+<a name="112" href="#112">112</a> }
+<a name="113" href="#113">113</a>
+<a name="114" href="#114">114</a> <em>/**<em>*</em></em>
+<a name="115" href="#115">115</a> <em> * Frequently called methods in log4j components can invoke this method in</em>
+<a name="116" href="#116">116</a> <em> * order to avoid flooding the output when logging lasting error conditions.</em>
+<a name="117" href="#117">117</a> <em> *</em>
+<a name="118" href="#118">118</a> <em> * @return a regular logger, or a NOPLogger if called too frequently.</em>
+<a name="119" href="#119">119</a> <em> */</em>
+<a name="120" href="#120">120</a> <strong>protected</strong> <a href="../../../../org/apache/log4j/ULogger.html">ULogger</a> getNonFloodingLogger() {
+<a name="121" href="#121">121</a> <strong>if</strong> (errorCount++ >= ERROR_COUNT_LIMIT) {
+<a name="122" href="#122">122</a> <strong>return</strong> NOPULogger.NOP_LOGGER;
+<a name="123" href="#123">123</a> } <strong>else</strong> {
+<a name="124" href="#124">124</a> <strong>return</strong> getLogger();
+<a name="125" href="#125">125</a> }
+<a name="126" href="#126">126</a> }
+<a name="127" href="#127">127</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ComponentBase.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ErrorItem.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ErrorItem.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ErrorItem.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ErrorItem.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,185 @@
+<!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>ErrorItem xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/spi/ErrorItem.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="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="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a>
+<a name="18" href="#18">18</a> <strong>package</strong> org.apache.log4j.spi;
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a> <strong>import</strong> java.io.PrintStream;
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <em>/**<em>*</em></em>
+<a name="23" href="#23">23</a> <em> * Used to store special log4j errors which cannot be logged using internal</em>
+<a name="24" href="#24">24</a> <em> * logging. Such errors include those occurring during the initial phases</em>
+<a name="25" href="#25">25</a> <em> * of log4j configuration or errors emanating from core components such as</em>
+<a name="26" href="#26">26</a> <em> * Logger or Hierarchy.</em>
+<a name="27" href="#27">27</a> <em> *</em>
+<a name="28" href="#28">28</a> <em> * @author Ceki Gulcu</em>
+<a name="29" href="#29">29</a> <em> */</em>
+<a name="30" href="#30">30</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/spi/ErrorItem.html">ErrorItem</a> {
+<a name="31" href="#31">31</a> <em>/**<em>*</em></em>
+<a name="32" href="#32">32</a> <em> * Message.</em>
+<a name="33" href="#33">33</a> <em> */</em>
+<a name="34" href="#34">34</a> String message;
+<a name="35" href="#35">35</a> <em>/**<em>*</em></em>
+<a name="36" href="#36">36</a> <em> * Column.</em>
+<a name="37" href="#37">37</a> <em> */</em>
+<a name="38" href="#38">38</a> <strong>int</strong> colNumber = -1;
+<a name="39" href="#39">39</a> <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a> <em> * Line number.</em>
+<a name="41" href="#41">41</a> <em> */</em>
+<a name="42" href="#42">42</a> <strong>int</strong> lineNumber = -1;
+<a name="43" href="#43">43</a> <em>/**<em>*</em></em>
+<a name="44" href="#44">44</a> <em> * Exception.</em>
+<a name="45" href="#45">45</a> <em> */</em>
+<a name="46" href="#46">46</a> Throwable exception;
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <em>/**<em>*</em></em>
+<a name="49" href="#49">49</a> <em> * Create new instance.</em>
+<a name="50" href="#50">50</a> <em> * @param message message</em>
+<a name="51" href="#51">51</a> <em> * @param e exception</em>
+<a name="52" href="#52">52</a> <em> */</em>
+<a name="53" href="#53">53</a> <strong>public</strong> <a href="../../../../org/apache/log4j/spi/ErrorItem.html">ErrorItem</a>(<strong>final</strong> String message, <strong>final</strong> Exception e) {
+<a name="54" href="#54">54</a> <strong>super</strong>();
+<a name="55" href="#55">55</a> <strong>this</strong>.message = message;
+<a name="56" href="#56">56</a> exception = e;
+<a name="57" href="#57">57</a> }
+<a name="58" href="#58">58</a>
+<a name="59" href="#59">59</a> <em>/**<em>*</em></em>
+<a name="60" href="#60">60</a> <em> * Creaet new instance.</em>
+<a name="61" href="#61">61</a> <em> * @param message message.</em>
+<a name="62" href="#62">62</a> <em> */</em>
+<a name="63" href="#63">63</a> <strong>public</strong> <a href="../../../../org/apache/log4j/spi/ErrorItem.html">ErrorItem</a>(<strong>final</strong> String message) {
+<a name="64" href="#64">64</a> <strong>this</strong>(message, <strong>null</strong>);
+<a name="65" href="#65">65</a> }
+<a name="66" href="#66">66</a>
+<a name="67" href="#67">67</a> <em>/**<em>*</em></em>
+<a name="68" href="#68">68</a> <em> * Get column number.</em>
+<a name="69" href="#69">69</a> <em> * @return column number.</em>
+<a name="70" href="#70">70</a> <em> */</em>
+<a name="71" href="#71">71</a> <strong>public</strong> <strong>int</strong> getColNumber() {
+<a name="72" href="#72">72</a> <strong>return</strong> colNumber;
+<a name="73" href="#73">73</a> }
+<a name="74" href="#74">74</a>
+<a name="75" href="#75">75</a> <em>/**<em>*</em></em>
+<a name="76" href="#76">76</a> <em> * Set column number.</em>
+<a name="77" href="#77">77</a> <em> * @param colNumber new column number.</em>
+<a name="78" href="#78">78</a> <em> */</em>
+<a name="79" href="#79">79</a> <strong>public</strong> <strong>void</strong> setColNumber(<strong>int</strong> colNumber) {
+<a name="80" href="#80">80</a> <strong>this</strong>.colNumber = colNumber;
+<a name="81" href="#81">81</a> }
+<a name="82" href="#82">82</a>
+<a name="83" href="#83">83</a> <em>/**<em>*</em></em>
+<a name="84" href="#84">84</a> <em> * Get exception.</em>
+<a name="85" href="#85">85</a> <em> * @return exception.</em>
+<a name="86" href="#86">86</a> <em> */</em>
+<a name="87" href="#87">87</a> <strong>public</strong> Throwable getException() {
+<a name="88" href="#88">88</a> <strong>return</strong> exception;
+<a name="89" href="#89">89</a> }
+<a name="90" href="#90">90</a>
+<a name="91" href="#91">91</a> <em>/**<em>*</em></em>
+<a name="92" href="#92">92</a> <em> * Set exception.</em>
+<a name="93" href="#93">93</a> <em> * @param exception exception</em>
+<a name="94" href="#94">94</a> <em> */</em>
+<a name="95" href="#95">95</a> <strong>public</strong> <strong>void</strong> setException(<strong>final</strong> Throwable exception) {
+<a name="96" href="#96">96</a> <strong>this</strong>.exception = exception;
+<a name="97" href="#97">97</a> }
+<a name="98" href="#98">98</a>
+<a name="99" href="#99">99</a> <em>/**<em>*</em></em>
+<a name="100" href="#100">100</a> <em> * Get line number.</em>
+<a name="101" href="#101">101</a> <em> * @return line number.</em>
+<a name="102" href="#102">102</a> <em> */</em>
+<a name="103" href="#103">103</a> <strong>public</strong> <strong>int</strong> getLineNumber() {
+<a name="104" href="#104">104</a> <strong>return</strong> lineNumber;
+<a name="105" href="#105">105</a> }
+<a name="106" href="#106">106</a>
+<a name="107" href="#107">107</a> <em>/**<em>*</em></em>
+<a name="108" href="#108">108</a> <em> * Set line number.</em>
+<a name="109" href="#109">109</a> <em> * @param lineNumber line number.</em>
+<a name="110" href="#110">110</a> <em> */</em>
+<a name="111" href="#111">111</a> <strong>public</strong> <strong>void</strong> setLineNumber(<strong>final</strong> <strong>int</strong> lineNumber) {
+<a name="112" href="#112">112</a> <strong>this</strong>.lineNumber = lineNumber;
+<a name="113" href="#113">113</a> }
+<a name="114" href="#114">114</a>
+<a name="115" href="#115">115</a> <em>/**<em>*</em></em>
+<a name="116" href="#116">116</a> <em> * Get message.</em>
+<a name="117" href="#117">117</a> <em> * @return message.</em>
+<a name="118" href="#118">118</a> <em> */</em>
+<a name="119" href="#119">119</a> <strong>public</strong> String getMessage() {
+<a name="120" href="#120">120</a> <strong>return</strong> message;
+<a name="121" href="#121">121</a> }
+<a name="122" href="#122">122</a>
+<a name="123" href="#123">123</a> <em>/**<em>*</em></em>
+<a name="124" href="#124">124</a> <em> * Set message.</em>
+<a name="125" href="#125">125</a> <em> * @param message message.</em>
+<a name="126" href="#126">126</a> <em> */</em>
+<a name="127" href="#127">127</a> <strong>public</strong> <strong>void</strong> setMessage(<strong>final</strong> String message) {
+<a name="128" href="#128">128</a> <strong>this</strong>.message = message;
+<a name="129" href="#129">129</a> }
+<a name="130" href="#130">130</a>
+<a name="131" href="#131">131</a> <em>/**<em>*</em></em>
+<a name="132" href="#132">132</a> <em> * String representation of ErrorItem.</em>
+<a name="133" href="#133">133</a> <em> * @return string.</em>
+<a name="134" href="#134">134</a> <em> */</em>
+<a name="135" href="#135">135</a> <strong>public</strong> String toString() {
+<a name="136" href="#136">136</a> String str =
+<a name="137" href="#137">137</a> <span class="string">"Reported error: \""</span> + message + <span class="string">"\""</span>;
+<a name="138" href="#138">138</a>
+<a name="139" href="#139">139</a> <strong>if</strong> (lineNumber != -1) {
+<a name="140" href="#140">140</a> str += <span class="string">" at line "</span> + lineNumber + <span class="string">" column "</span> + colNumber;
+<a name="141" href="#141">141</a> }
+<a name="142" href="#142">142</a> <strong>if</strong> (exception != <strong>null</strong>) {
+<a name="143" href="#143">143</a> str += (<span class="string">" with exception "</span> + exception);
+<a name="144" href="#144">144</a> }
+<a name="145" href="#145">145</a> <strong>return</strong> str;
+<a name="146" href="#146">146</a> }
+<a name="147" href="#147">147</a>
+<a name="148" href="#148">148</a> <em>/**<em>*</em></em>
+<a name="149" href="#149">149</a> <em> * Dump the details of this ErrorItem to System.out.</em>
+<a name="150" href="#150">150</a> <em> */</em>
+<a name="151" href="#151">151</a> <strong>public</strong> <strong>void</strong> dump() {
+<a name="152" href="#152">152</a> dump(System.out);
+<a name="153" href="#153">153</a> }
+<a name="154" href="#154">154</a>
+<a name="155" href="#155">155</a> <em>/**<em>*</em></em>
+<a name="156" href="#156">156</a> <em> * Dump the details of this ErrorItem on the specified {@link PrintStream}.</em>
+<a name="157" href="#157">157</a> <em> * @param ps print stream.</em>
+<a name="158" href="#158">158</a> <em> */</em>
+<a name="159" href="#159">159</a> <strong>public</strong> <strong>void</strong> dump(<strong>final</strong> PrintStream ps) {
+<a name="160" href="#160">160</a> String str =
+<a name="161" href="#161">161</a> <span class="string">"Reported error: \""</span> + message + <span class="string">"\""</span>;
+<a name="162" href="#162">162</a>
+<a name="163" href="#163">163</a> <strong>if</strong> (lineNumber != -1) {
+<a name="164" href="#164">164</a> str += <span class="string">" at line "</span> + lineNumber + <span class="string">" column "</span> + colNumber;
+<a name="165" href="#165">165</a> }
+<a name="166" href="#166">166</a> ps.println(str);
+<a name="167" href="#167">167</a>
+<a name="168" href="#168">168</a> <strong>if</strong> (exception != <strong>null</strong>) {
+<a name="169" href="#169">169</a> exception.printStackTrace(ps);
+<a name="170" href="#170">170</a> }
+<a name="171" href="#171">171</a> }
+<a name="172" href="#172">172</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/ErrorItem.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Log4JULogger.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Log4JULogger.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Log4JULogger.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Log4JULogger.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,242 @@
+<!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>Log4JULogger xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/spi/Log4JULogger.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="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="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a> <strong>package</strong> org.apache.log4j.spi;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a> <strong>import</strong> org.apache.log4j.Logger;
+<a name="20" href="#20">20</a> <strong>import</strong> org.apache.log4j.ULogger;
+<a name="21" href="#21">21</a> <strong>import</strong> org.apache.log4j.helpers.MessageFormatter;
+<a name="22" href="#22">22</a> <strong>import</strong> org.apache.log4j.Level;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a>
+<a name="25" href="#25">25</a> <em>/**<em>*</em></em>
+<a name="26" href="#26">26</a> <em> * An implementation of ULogger on org.apache.log4j.Logger.</em>
+<a name="27" href="#27">27</a> <em> */</em>
+<a name="28" href="#28">28</a> <strong>public</strong> <strong>final</strong> <strong>class</strong> Log4JULogger implements <a href="../../../../org/apache/log4j/ULogger.html">ULogger</a> {
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <em>/**<em>*</em></em>
+<a name="31" href="#31">31</a> <em> * Wrapped log4j logger.</em>
+<a name="32" href="#32">32</a> <em> */</em>
+<a name="33" href="#33">33</a> <strong>private</strong> <strong>final</strong> Logger logger;
+<a name="34" href="#34">34</a>
+<a name="35" href="#35">35</a> <em>/**<em>*</em></em>
+<a name="36" href="#36">36</a> <em> * Create a new instance.</em>
+<a name="37" href="#37">37</a> <em> *</em>
+<a name="38" href="#38">38</a> <em> * @param l logger, may not be null.</em>
+<a name="39" href="#39">39</a> <em> */</em>
+<a name="40" href="#40">40</a> <strong>public</strong> Log4JULogger(<strong>final</strong> Logger l) {
+<a name="41" href="#41">41</a> <strong>super</strong>();
+<a name="42" href="#42">42</a> <strong>if</strong> (l == <strong>null</strong>) {
+<a name="43" href="#43">43</a> <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"l"</span>);
+<a name="44" href="#44">44</a> }
+<a name="45" href="#45">45</a> logger = l;
+<a name="46" href="#46">46</a> }
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <em>/**<em>*</em></em>
+<a name="49" href="#49">49</a> <em> * {@inheritDoc}</em>
+<a name="50" href="#50">50</a> <em> */</em>
+<a name="51" href="#51">51</a> <strong>public</strong> <strong>boolean</strong> isDebugEnabled() {
+<a name="52" href="#52">52</a> <strong>return</strong> logger.isDebugEnabled();
+<a name="53" href="#53">53</a> }
+<a name="54" href="#54">54</a>
+<a name="55" href="#55">55</a> <em>/**<em>*</em></em>
+<a name="56" href="#56">56</a> <em> * {@inheritDoc}</em>
+<a name="57" href="#57">57</a> <em> */</em>
+<a name="58" href="#58">58</a> <strong>public</strong> <strong>void</strong> debug(<strong>final</strong> Object msg) {
+<a name="59" href="#59">59</a> logger.debug(msg);
+<a name="60" href="#60">60</a> }
+<a name="61" href="#61">61</a>
+<a name="62" href="#62">62</a> <em>/**<em>*</em></em>
+<a name="63" href="#63">63</a> <em> * {@inheritDoc}</em>
+<a name="64" href="#64">64</a> <em> */</em>
+<a name="65" href="#65">65</a> <strong>public</strong> <strong>void</strong> debug(<strong>final</strong> Object parameterizedMsg,
+<a name="66" href="#66">66</a> <strong>final</strong> Object param1) {
+<a name="67" href="#67">67</a> <strong>if</strong> (logger.isDebugEnabled()) {
+<a name="68" href="#68">68</a> logger.debug(MessageFormatter.format(
+<a name="69" href="#69">69</a> parameterizedMsg.toString(), param1));
+<a name="70" href="#70">70</a> }
+<a name="71" href="#71">71</a> }
+<a name="72" href="#72">72</a>
+<a name="73" href="#73">73</a> <em>/**<em>*</em></em>
+<a name="74" href="#74">74</a> <em> * {@inheritDoc}</em>
+<a name="75" href="#75">75</a> <em> */</em>
+<a name="76" href="#76">76</a> <strong>public</strong> <strong>void</strong> debug(<strong>final</strong> String parameterizedMsg,
+<a name="77" href="#77">77</a> <strong>final</strong> Object param1,
+<a name="78" href="#78">78</a> <strong>final</strong> Object param2) {
+<a name="79" href="#79">79</a> <strong>if</strong> (logger.isDebugEnabled()) {
+<a name="80" href="#80">80</a> logger.debug(MessageFormatter.format(
+<a name="81" href="#81">81</a> parameterizedMsg.toString(), param1, param2));
+<a name="82" href="#82">82</a> }
+<a name="83" href="#83">83</a> }
+<a name="84" href="#84">84</a>
+<a name="85" href="#85">85</a> <em>/**<em>*</em></em>
+<a name="86" href="#86">86</a> <em> * {@inheritDoc}</em>
+<a name="87" href="#87">87</a> <em> */</em>
+<a name="88" href="#88">88</a> <strong>public</strong> <strong>void</strong> debug(<strong>final</strong> Object msg,
+<a name="89" href="#89">89</a> <strong>final</strong> Throwable t) {
+<a name="90" href="#90">90</a> logger.debug(msg, t);
+<a name="91" href="#91">91</a> }
+<a name="92" href="#92">92</a>
+<a name="93" href="#93">93</a>
+<a name="94" href="#94">94</a> <em>/**<em>*</em></em>
+<a name="95" href="#95">95</a> <em> * {@inheritDoc}</em>
+<a name="96" href="#96">96</a> <em> */</em>
+<a name="97" href="#97">97</a> <strong>public</strong> <strong>boolean</strong> isInfoEnabled() {
+<a name="98" href="#98">98</a> <strong>return</strong> logger.isInfoEnabled();
+<a name="99" href="#99">99</a> }
+<a name="100" href="#100">100</a>
+<a name="101" href="#101">101</a> <em>/**<em>*</em></em>
+<a name="102" href="#102">102</a> <em> * {@inheritDoc}</em>
+<a name="103" href="#103">103</a> <em> */</em>
+<a name="104" href="#104">104</a> <strong>public</strong> <strong>void</strong> info(<strong>final</strong> Object msg) {
+<a name="105" href="#105">105</a> logger.info(msg);
+<a name="106" href="#106">106</a> }
+<a name="107" href="#107">107</a>
+<a name="108" href="#108">108</a>
+<a name="109" href="#109">109</a> <em>/**<em>*</em></em>
+<a name="110" href="#110">110</a> <em> * {@inheritDoc}</em>
+<a name="111" href="#111">111</a> <em> */</em>
+<a name="112" href="#112">112</a> <strong>public</strong> <strong>void</strong> info(<strong>final</strong> Object parameterizedMsg,
+<a name="113" href="#113">113</a> <strong>final</strong> Object param1) {
+<a name="114" href="#114">114</a> <strong>if</strong> (logger.isInfoEnabled()) {
+<a name="115" href="#115">115</a> logger.info(MessageFormatter.format(
+<a name="116" href="#116">116</a> parameterizedMsg.toString(), param1));
+<a name="117" href="#117">117</a> }
+<a name="118" href="#118">118</a> }
+<a name="119" href="#119">119</a>
+<a name="120" href="#120">120</a> <em>/**<em>*</em></em>
+<a name="121" href="#121">121</a> <em> * {@inheritDoc}</em>
+<a name="122" href="#122">122</a> <em> */</em>
+<a name="123" href="#123">123</a> <strong>public</strong> <strong>void</strong> info(<strong>final</strong> String parameterizedMsg,
+<a name="124" href="#124">124</a> <strong>final</strong> Object param1,
+<a name="125" href="#125">125</a> <strong>final</strong> Object param2) {
+<a name="126" href="#126">126</a> <strong>if</strong> (logger.isInfoEnabled()) {
+<a name="127" href="#127">127</a> logger.info(MessageFormatter.format(
+<a name="128" href="#128">128</a> parameterizedMsg.toString(),
+<a name="129" href="#129">129</a> param1,
+<a name="130" href="#130">130</a> param2));
+<a name="131" href="#131">131</a> }
+<a name="132" href="#132">132</a> }
+<a name="133" href="#133">133</a>
+<a name="134" href="#134">134</a> <em>/**<em>*</em></em>
+<a name="135" href="#135">135</a> <em> * {@inheritDoc}</em>
+<a name="136" href="#136">136</a> <em> */</em>
+<a name="137" href="#137">137</a> <strong>public</strong> <strong>void</strong> info(<strong>final</strong> Object msg, <strong>final</strong> Throwable t) {
+<a name="138" href="#138">138</a> logger.info(msg, t);
+<a name="139" href="#139">139</a> }
+<a name="140" href="#140">140</a>
+<a name="141" href="#141">141</a> <em>/**<em>*</em></em>
+<a name="142" href="#142">142</a> <em> * {@inheritDoc}</em>
+<a name="143" href="#143">143</a> <em> */</em>
+<a name="144" href="#144">144</a> <strong>public</strong> <strong>boolean</strong> isWarnEnabled() {
+<a name="145" href="#145">145</a> <strong>return</strong> logger.isEnabledFor(Level.WARN);
+<a name="146" href="#146">146</a> }
+<a name="147" href="#147">147</a>
+<a name="148" href="#148">148</a> <em>/**<em>*</em></em>
+<a name="149" href="#149">149</a> <em> * {@inheritDoc}</em>
+<a name="150" href="#150">150</a> <em> */</em>
+<a name="151" href="#151">151</a> <strong>public</strong> <strong>void</strong> warn(<strong>final</strong> Object msg) {
+<a name="152" href="#152">152</a> logger.warn(msg);
+<a name="153" href="#153">153</a> }
+<a name="154" href="#154">154</a>
+<a name="155" href="#155">155</a> <em>/**<em>*</em></em>
+<a name="156" href="#156">156</a> <em> * {@inheritDoc}</em>
+<a name="157" href="#157">157</a> <em> */</em>
+<a name="158" href="#158">158</a> <strong>public</strong> <strong>void</strong> warn(<strong>final</strong> Object parameterizedMsg,
+<a name="159" href="#159">159</a> <strong>final</strong> Object param1) {
+<a name="160" href="#160">160</a> <strong>if</strong> (logger.isEnabledFor(Level.WARN)) {
+<a name="161" href="#161">161</a> logger.warn(MessageFormatter.format(
+<a name="162" href="#162">162</a> parameterizedMsg.toString(), param1));
+<a name="163" href="#163">163</a> }
+<a name="164" href="#164">164</a> }
+<a name="165" href="#165">165</a>
+<a name="166" href="#166">166</a> <em>/**<em>*</em></em>
+<a name="167" href="#167">167</a> <em> * {@inheritDoc}</em>
+<a name="168" href="#168">168</a> <em> */</em>
+<a name="169" href="#169">169</a> <strong>public</strong> <strong>void</strong> warn(<strong>final</strong> String parameterizedMsg,
+<a name="170" href="#170">170</a> <strong>final</strong> Object param1,
+<a name="171" href="#171">171</a> <strong>final</strong> Object param2) {
+<a name="172" href="#172">172</a> <strong>if</strong> (logger.isEnabledFor(Level.WARN)) {
+<a name="173" href="#173">173</a> logger.warn(MessageFormatter.format(
+<a name="174" href="#174">174</a> parameterizedMsg.toString(), param1, param2));
+<a name="175" href="#175">175</a> }
+<a name="176" href="#176">176</a> }
+<a name="177" href="#177">177</a>
+<a name="178" href="#178">178</a> <em>/**<em>*</em></em>
+<a name="179" href="#179">179</a> <em> * {@inheritDoc}</em>
+<a name="180" href="#180">180</a> <em> */</em>
+<a name="181" href="#181">181</a> <strong>public</strong> <strong>void</strong> warn(<strong>final</strong> Object msg, <strong>final</strong> Throwable t) {
+<a name="182" href="#182">182</a> logger.warn(msg, t);
+<a name="183" href="#183">183</a> }
+<a name="184" href="#184">184</a>
+<a name="185" href="#185">185</a> <em>/**<em>*</em></em>
+<a name="186" href="#186">186</a> <em> * {@inheritDoc}</em>
+<a name="187" href="#187">187</a> <em> */</em>
+<a name="188" href="#188">188</a> <strong>public</strong> <strong>boolean</strong> isErrorEnabled() {
+<a name="189" href="#189">189</a> <strong>return</strong> logger.isEnabledFor(Level.ERROR);
+<a name="190" href="#190">190</a> }
+<a name="191" href="#191">191</a>
+<a name="192" href="#192">192</a> <em>/**<em>*</em></em>
+<a name="193" href="#193">193</a> <em> * {@inheritDoc}</em>
+<a name="194" href="#194">194</a> <em> */</em>
+<a name="195" href="#195">195</a> <strong>public</strong> <strong>void</strong> error(<strong>final</strong> Object msg) {
+<a name="196" href="#196">196</a> logger.error(msg);
+<a name="197" href="#197">197</a> }
+<a name="198" href="#198">198</a>
+<a name="199" href="#199">199</a>
+<a name="200" href="#200">200</a> <em>/**<em>*</em></em>
+<a name="201" href="#201">201</a> <em> * {@inheritDoc}</em>
+<a name="202" href="#202">202</a> <em> */</em>
+<a name="203" href="#203">203</a> <strong>public</strong> <strong>void</strong> error(<strong>final</strong> Object parameterizedMsg, <strong>final</strong> Object param1) {
+<a name="204" href="#204">204</a> <strong>if</strong> (logger.isEnabledFor(Level.ERROR)) {
+<a name="205" href="#205">205</a> logger.error(MessageFormatter.format(
+<a name="206" href="#206">206</a> parameterizedMsg.toString(), param1));
+<a name="207" href="#207">207</a> }
+<a name="208" href="#208">208</a> }
+<a name="209" href="#209">209</a>
+<a name="210" href="#210">210</a> <em>/**<em>*</em></em>
+<a name="211" href="#211">211</a> <em> * {@inheritDoc}</em>
+<a name="212" href="#212">212</a> <em> */</em>
+<a name="213" href="#213">213</a> <strong>public</strong> <strong>void</strong> error(<strong>final</strong> String parameterizedMsg,
+<a name="214" href="#214">214</a> <strong>final</strong> Object param1,
+<a name="215" href="#215">215</a> <strong>final</strong> Object param2) {
+<a name="216" href="#216">216</a> <strong>if</strong> (logger.isEnabledFor(Level.ERROR)) {
+<a name="217" href="#217">217</a> logger.error(MessageFormatter.format(
+<a name="218" href="#218">218</a> parameterizedMsg.toString(), param1, param2));
+<a name="219" href="#219">219</a> }
+<a name="220" href="#220">220</a> }
+<a name="221" href="#221">221</a>
+<a name="222" href="#222">222</a> <em>/**<em>*</em></em>
+<a name="223" href="#223">223</a> <em> * {@inheritDoc}</em>
+<a name="224" href="#224">224</a> <em> */</em>
+<a name="225" href="#225">225</a> <strong>public</strong> <strong>void</strong> error(<strong>final</strong> Object msg, <strong>final</strong> Throwable t) {
+<a name="226" href="#226">226</a> logger.error(msg, t);
+<a name="227" href="#227">227</a> }
+<a name="228" href="#228">228</a>
+<a name="229" href="#229">229</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/Log4JULogger.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/LoggerEventListener.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/LoggerEventListener.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/LoggerEventListener.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/LoggerEventListener.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,73 @@
+<!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>LoggerEventListener xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/spi/LoggerEventListener.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="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="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a>
+<a name="18" href="#18">18</a> <strong>package</strong> org.apache.log4j.spi;
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a> <strong>import</strong> org.apache.log4j.Appender;
+<a name="21" href="#21">21</a> <strong>import</strong> org.apache.log4j.Logger;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <em>/**<em>*</em></em>
+<a name="25" href="#25">25</a> <em> Interface used to listen for Logger related events such as</em>
+<a name="26" href="#26">26</a> <em> add/remove appender or changing levels. Clients register an instance of</em>
+<a name="27" href="#27">27</a> <em> the interface and the instance is called back when the various events occur.</em>
+<a name="28" href="#28">28</a>
+<a name="29" href="#29">29</a> <em> LoggerRepository provides methods for adding and removing</em>
+<a name="30" href="#30">30</a> <em> LoggerEventListener instances.</em>
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em> When implementing the methods of this interface, it is useful to remember</em>
+<a name="33" href="#33">33</a> <em> that the Logger can access the repository using its getRepository()</em>
+<a name="34" href="#34">34</a> <em> method.</em>
+<a name="35" href="#35">35</a>
+<a name="36" href="#36">36</a> <em> @author Ceki G&uuml;lc&uuml;</em>
+<a name="37" href="#37">37</a> <em> @author Mark Womack</em>
+<a name="38" href="#38">38</a> <em> @since 1.3</em>
+<a name="39" href="#39">39</a> <em>*/</em>
+<a name="40" href="#40">40</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/spi/LoggerEventListener.html">LoggerEventListener</a> {
+<a name="41" href="#41">41</a> <em>/**<em>*</em></em>
+<a name="42" href="#42">42</a> <em> Called when an appender is added to the logger.</em>
+<a name="43" href="#43">43</a>
+<a name="44" href="#44">44</a> <em> @param logger The logger to which the appender was added.</em>
+<a name="45" href="#45">45</a> <em> @param appender The appender added to the logger. */</em>
+<a name="46" href="#46">46</a> <strong>void</strong> appenderAddedEvent(Logger logger, Appender appender);
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <em>/**<em>*</em></em>
+<a name="49" href="#49">49</a> <em> Called when an appender is removed from the logger.</em>
+<a name="50" href="#50">50</a>
+<a name="51" href="#51">51</a> <em> @param logger The logger from which the appender was removed.</em>
+<a name="52" href="#52">52</a> <em> @param appender The appender removed from the logger. */</em>
+<a name="53" href="#53">53</a> <strong>void</strong> appenderRemovedEvent(Logger logger, Appender appender);
+<a name="54" href="#54">54</a>
+<a name="55" href="#55">55</a> <em>/**<em>*</em></em>
+<a name="56" href="#56">56</a> <em> Called when level changed on the logger.</em>
+<a name="57" href="#57">57</a>
+<a name="58" href="#58">58</a> <em> @param logger The logger that changed levels. */</em>
+<a name="59" href="#59">59</a> <strong>void</strong> levelChangedEvent(Logger logger);
+<a name="60" href="#60">60</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/spi/LoggerEventListener.html
------------------------------------------------------------------------------
svn:mime-type = text/html