logging-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From carn...@apache.org
Subject svn commit: r558355 [20/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/...
Date Sat, 21 Jul 2007 17:21:03 GMT
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/MessageFormatter.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/MessageFormatter.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/MessageFormatter.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/MessageFormatter.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,166 @@
+<!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>MessageFormatter xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/helpers/MessageFormatter.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"> * Copyright 1999,2005 The Apache Software Foundation.</em>
+<a name="3" href="#3">3</a>   <em class="comment"> *</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * you may not use this file except in compliance with the License.</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * You may obtain a copy of the License at</em>
+<a name="7" href="#7">7</a>   <em class="comment"> *</em>
+<a name="8" href="#8">8</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="9" href="#9">9</a>   <em class="comment"> *</em>
+<a name="10" href="#10">10</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * limitations under the License.</em>
+<a name="15" href="#15">15</a>  <em class="comment"> */</em>
+<a name="16" href="#16">16</a>  
+<a name="17" href="#17">17</a>  <strong>package</strong> org.apache.log4j.helpers;
+<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> * Formats messages according to very simple rules.</em>
+<a name="22" href="#22">22</a>  <em> * See {@link #format(String,Object)} and</em>
+<a name="23" href="#23">23</a>  <em> * {@link #format(String,Object,Object)} for more details.</em>
+<a name="24" href="#24">24</a>  <em> *</em>
+<a name="25" href="#25">25</a>  <em> * @author Ceki G&amp;uuml;lc&amp;uuml;</em>
+<a name="26" href="#26">26</a>  <em> */</em>
+<a name="27" href="#27">27</a>  <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/helpers/MessageFormatter.html">MessageFormatter</a> {
+<a name="28" href="#28">28</a>      <em>/**<em>*</em></em>
+<a name="29" href="#29">29</a>  <em>     * Private formatter since all methods and members are static.</em>
+<a name="30" href="#30">30</a>  <em>     */</em>
+<a name="31" href="#31">31</a>      <strong>private</strong> <a href="../../../../org/apache/log4j/helpers/MessageFormatter.html">MessageFormatter</a>() {
+<a name="32" href="#32">32</a>          <strong>super</strong>();
+<a name="33" href="#33">33</a>      }
+<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>     * Start of replacement block.</em>
+<a name="37" href="#37">37</a>  <em>     */</em>
+<a name="38" href="#38">38</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> DELIM_START = '{';
+<a name="39" href="#39">39</a>      <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a>  <em>     * End of replacement block.</em>
+<a name="41" href="#41">41</a>  <em>     */</em>
+<a name="42" href="#42">42</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong> DELIM_STOP = '}';
+<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>     * Performs single argument substitution for the 'messagePattern' passed as</em>
+<a name="46" href="#46">46</a>  <em>     * parameter.</em>
+<a name="47" href="#47">47</a>  <em>     * &lt;p/></em>
+<a name="48" href="#48">48</a>  <em>     * For example, &lt;code>MessageFormatter.format("Hi {}.", "there");&lt;/code></em>
+<a name="49" href="#49">49</a>  <em>     * will return the string "Hi there.".</em>
+<a name="50" href="#50">50</a>  <em>     * &lt;p/></em>
+<a name="51" href="#51">51</a>  <em>     * The {} pair is called the formatting element. It serves to designate the</em>
+<a name="52" href="#52">52</a>  <em>     * location where the argument needs to be inserted within the pattern.</em>
+<a name="53" href="#53">53</a>  <em>     *</em>
+<a name="54" href="#54">54</a>  <em>     * @param messagePattern</em>
+<a name="55" href="#55">55</a>  <em>     *     The message pattern which will be parsed and formatted</em>
+<a name="56" href="#56">56</a>  <em>     * @param argument</em>
+<a name="57" href="#57">57</a>  <em>     *     The argument to be inserted instead of the formatting element</em>
+<a name="58" href="#58">58</a>  <em>     * @return The formatted message</em>
+<a name="59" href="#59">59</a>  <em>     */</em>
+<a name="60" href="#60">60</a>      <strong>public</strong> <strong>static</strong> String format(<strong>final</strong> String messagePattern,
+<a name="61" href="#61">61</a>                                  <strong>final</strong> Object argument) {
+<a name="62" href="#62">62</a>          <strong>int</strong> j = messagePattern.indexOf(DELIM_START);
+<a name="63" href="#63">63</a>          <strong>int</strong> len = messagePattern.length();
+<a name="64" href="#64">64</a>          <strong>char</strong> escape = 'x';
+<a name="65" href="#65">65</a>  
+<a name="66" href="#66">66</a>          <em class="comment">// if there are no { characters or { is the last character</em>
+<a name="67" href="#67">67</a>          <em class="comment">// then we just return messagePattern</em>
+<a name="68" href="#68">68</a>          <strong>if</strong> (j == -1 || (j + 1 == len)) {
+<a name="69" href="#69">69</a>              <strong>return</strong> messagePattern;
+<a name="70" href="#70">70</a>          } <strong>else</strong> {
+<a name="71" href="#71">71</a>              <strong>char</strong> delimStop = messagePattern.<strong>char</strong>At(j + 1);
+<a name="72" href="#72">72</a>              <strong>if</strong> (j > 0) {
+<a name="73" href="#73">73</a>                  escape = messagePattern.charAt(j - 1);
+<a name="74" href="#74">74</a>              }
+<a name="75" href="#75">75</a>              <strong>if</strong> ((delimStop != DELIM_STOP) || (escape == '&#47;&#47;')) {
+<a name="76" href="#76">76</a>                  <em class="comment">// invalid DELIM_START/DELIM_STOP pair or espace character is</em>
+<a name="77" href="#77">77</a>                  <em class="comment">// present</em>
+<a name="78" href="#78">78</a>                  <strong>return</strong> messagePattern;
+<a name="79" href="#79">79</a>              } <strong>else</strong> {
+<a name="80" href="#80">80</a>                  StringBuffer sbuf = <strong>new</strong> StringBuffer(len + 20);
+<a name="81" href="#81">81</a>                  sbuf.append(messagePattern.substring(0, j));
+<a name="82" href="#82">82</a>                  sbuf.append(argument);
+<a name="83" href="#83">83</a>                  sbuf.append(messagePattern.substring(j + 2));
+<a name="84" href="#84">84</a>                  <strong>return</strong> sbuf.toString();
+<a name="85" href="#85">85</a>              }
+<a name="86" href="#86">86</a>          }
+<a name="87" href="#87">87</a>      }
+<a name="88" href="#88">88</a>  
+<a name="89" href="#89">89</a>      <em>/**<em>*</em></em>
+<a name="90" href="#90">90</a>  <em>     * /**</em>
+<a name="91" href="#91">91</a>  <em>     * Performs a two argument substitution for the 'messagePattern' passed as</em>
+<a name="92" href="#92">92</a>  <em>     * parameter.</em>
+<a name="93" href="#93">93</a>  <em>     * &lt;p/></em>
+<a name="94" href="#94">94</a>  <em>     * For example, &lt;code>MessageFormatter.format("Hi {}. My name is {}.",</em>
+<a name="95" href="#95">95</a>  <em>     * "there", "David");&lt;/code> will return the string</em>
+<a name="96" href="#96">96</a>  <em>     * "Hi there. My name is David.".</em>
+<a name="97" href="#97">97</a>  <em>     * &lt;p/></em>
+<a name="98" href="#98">98</a>  <em>     * The '{}' pair is called a formatting element. It serves to designate the</em>
+<a name="99" href="#99">99</a>  <em>     * location where the arguments need to be inserted within</em>
+<a name="100" href="#100">100</a> <em>     * the message pattern.</em>
+<a name="101" href="#101">101</a> <em>     *</em>
+<a name="102" href="#102">102</a> <em>     * @param messagePattern</em>
+<a name="103" href="#103">103</a> <em>     *     The message pattern which will be parsed and formatted</em>
+<a name="104" href="#104">104</a> <em>     * @param arg1</em>
+<a name="105" href="#105">105</a> <em>     *     The first argument to replace the first formatting element</em>
+<a name="106" href="#106">106</a> <em>     * @param arg2</em>
+<a name="107" href="#107">107</a> <em>     *     The second argument to replace the second formatting element</em>
+<a name="108" href="#108">108</a> <em>     * @return The formatted message</em>
+<a name="109" href="#109">109</a> <em>     */</em>
+<a name="110" href="#110">110</a>     <strong>public</strong> <strong>static</strong> String format(<strong>final</strong> String messagePattern,
+<a name="111" href="#111">111</a>                                 <strong>final</strong> Object arg1,
+<a name="112" href="#112">112</a>                                 <strong>final</strong> Object arg2) {
+<a name="113" href="#113">113</a>         <strong>int</strong> i = 0;
+<a name="114" href="#114">114</a>         <strong>int</strong> len = messagePattern.length();
+<a name="115" href="#115">115</a> 
+<a name="116" href="#116">116</a>         StringBuffer sbuf = <strong>new</strong> StringBuffer(messagePattern.length() + 50);
+<a name="117" href="#117">117</a> 
+<a name="118" href="#118">118</a>         <strong>for</strong> (<strong>int</strong> l = 0; l &lt; 2; l++) {
+<a name="119" href="#119">119</a>             <strong>int</strong> j = messagePattern.indexOf(DELIM_START, i);
+<a name="120" href="#120">120</a> 
+<a name="121" href="#121">121</a>             <strong>if</strong> (j == -1 || (j + 1 == len)) {
+<a name="122" href="#122">122</a>                 <em class="comment">// no more variables</em>
+<a name="123" href="#123">123</a>                 <strong>if</strong> (i == 0) { <em class="comment">// this is a simple string</em>
+<a name="124" href="#124">124</a>                     <strong>return</strong> messagePattern;
+<a name="125" href="#125">125</a>                 } <strong>else</strong> {
+<a name="126" href="#126">126</a>                     <em class="comment">// add the tail string which contains no variables</em>
+<a name="127" href="#127">127</a>                     <em class="comment">// and return the result.</em>
+<a name="128" href="#128">128</a>                     sbuf.append(messagePattern.substring(i,
+<a name="129" href="#129">129</a>                                     messagePattern.length()));
+<a name="130" href="#130">130</a>                     <strong>return</strong> sbuf.toString();
+<a name="131" href="#131">131</a>                 }
+<a name="132" href="#132">132</a>             } <strong>else</strong> {
+<a name="133" href="#133">133</a>                 <strong>char</strong> delimStop = messagePattern.<strong>char</strong>At(j + 1);
+<a name="134" href="#134">134</a>                 <strong>if</strong> ((delimStop != DELIM_STOP)) {
+<a name="135" href="#135">135</a>                     <em class="comment">// invalid DELIM_START/DELIM_STOP pair</em>
+<a name="136" href="#136">136</a>                     sbuf.append(messagePattern.substring(i,
+<a name="137" href="#137">137</a>                             messagePattern.length()));
+<a name="138" href="#138">138</a>                     <strong>return</strong> sbuf.toString();
+<a name="139" href="#139">139</a>                 }
+<a name="140" href="#140">140</a>                 sbuf.append(messagePattern.substring(i, j));
+<a name="141" href="#141">141</a>                 <strong>if</strong> (l == 0) {
+<a name="142" href="#142">142</a>                     sbuf.append(arg1);
+<a name="143" href="#143">143</a>                 } <strong>else</strong> {
+<a name="144" href="#144">144</a>                     sbuf.append(arg2);
+<a name="145" href="#145">145</a>                 }
+<a name="146" href="#146">146</a>                 i = j + 2;
+<a name="147" href="#147">147</a>             }
+<a name="148" href="#148">148</a>         }
+<a name="149" href="#149">149</a>         <em class="comment">// append the characters following the second {} pair.</em>
+<a name="150" href="#150">150</a>         sbuf.append(messagePattern.substring(i, messagePattern.length()));
+<a name="151" href="#151">151</a>         <strong>return</strong> sbuf.toString();
+<a name="152" href="#152">152</a>     }
+<a name="153" href="#153">153</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/helpers/MessageFormatter.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-frame.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-frame.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-frame.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/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.helpers</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.helpers</a>
+      	</h3>
+
+      	<h3>Classes</h3>
+
+      	<ul>
+      		          	<li>
+            	<a href="Constants.html" target="classFrame">Constants</a>
+          	</li>
+          	          	<li>
+            	<a href="MessageFormatter.html" target="classFrame">MessageFormatter</a>
+          	</li>
+          	      	</ul>
+
+	</body>
+</html>
\ No newline at end of file

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-frame.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-summary.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-summary.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/package-summary.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/helpers/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.helpers</h2>
+
+		<table class="summary">
+        	<thead>
+          		<tr>
+            		<th>Class Summary</th>
+          		</tr>
+        	</thead>
+        	<tbody>
+        		            	<tr>
+              		<td>
+                		<a href="Constants.html" target="classFrame">Constants</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="MessageFormatter.html" target="classFrame">MessageFormatter</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 &copy; 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/helpers/package-summary.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-frame.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-frame.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-frame.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/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</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</a>
+      	</h3>
+
+      	<h3>Classes</h3>
+
+      	<ul>
+      		          	<li>
+            	<a href="LoggerRepositoryExImpl.html" target="classFrame">LoggerRepositoryExImpl</a>
+          	</li>
+          	          	<li>
+            	<a href="ULogger.html" target="classFrame">ULogger</a>
+          	</li>
+          	      	</ul>
+
+	</body>
+</html>
\ No newline at end of file

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-frame.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-summary.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-summary.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/package-summary.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/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</h2>
+
+		<table class="summary">
+        	<thead>
+          		<tr>
+            		<th>Class Summary</th>
+          		</tr>
+        	</thead>
+        	<tbody>
+        		            	<tr>
+              		<td>
+                		<a href="LoggerRepositoryExImpl.html" target="classFrame">LoggerRepositoryExImpl</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="ULogger.html" target="classFrame">ULogger</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 &copy; 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/package-summary.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Pauseable.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Pauseable.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Pauseable.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Pauseable.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,52 @@
+<!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>Pauseable xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/Pauseable.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.plugins;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  
+<a name="21" href="#21">21</a>  <em>/**<em>*</em></em>
+<a name="22" href="#22">22</a>  <em> * Instances of this interface can be paused, and resumed.</em>
+<a name="23" href="#23">23</a>  <em> *</em>
+<a name="24" href="#24">24</a>  <em> * @author Paul Smith (psmith@apache.org)</em>
+<a name="25" href="#25">25</a>  <em> *</em>
+<a name="26" href="#26">26</a>  <em> */</em>
+<a name="27" href="#27">27</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/plugins/Pauseable.html">Pauseable</a> {
+<a name="28" href="#28">28</a>      <em>/**<em>*</em></em>
+<a name="29" href="#29">29</a>  <em>     * Set paused state.</em>
+<a name="30" href="#30">30</a>  <em>     * @param paused new value</em>
+<a name="31" href="#31">31</a>  <em>     */</em>
+<a name="32" href="#32">32</a>    <strong>void</strong> setPaused(<strong>boolean</strong> paused);
+<a name="33" href="#33">33</a>  
+<a name="34" href="#34">34</a>      <em>/**<em>*</em></em>
+<a name="35" href="#35">35</a>  <em>     * Get paused state.</em>
+<a name="36" href="#36">36</a>  <em>     * @return paused state.</em>
+<a name="37" href="#37">37</a>  <em>     */</em>
+<a name="38" href="#38">38</a>    <strong>boolean</strong> isPaused();
+<a name="39" href="#39">39</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/plugins/Pauseable.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Plugin.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Plugin.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Plugin.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Plugin.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,158 @@
+<!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>Plugin xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/Plugin.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.plugins;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepository;
+<a name="21" href="#21">21</a>  <strong>import</strong> org.apache.log4j.spi.OptionHandler;
+<a name="22" href="#22">22</a>  
+<a name="23" href="#23">23</a>  <strong>import</strong> java.beans.PropertyChangeListener;
+<a name="24" href="#24">24</a>  
+<a name="25" href="#25">25</a>  
+<a name="26" href="#26">26</a>  <em>/**<em>*</em></em>
+<a name="27" href="#27">27</a>  <em> * Defines the required interface for all Plugin objects.</em>
+<a name="28" href="#28">28</a>  <em> * &lt;p/></em>
+<a name="29" href="#29">29</a>  <em> * &lt;p>A plugin implements some specific functionality to extend</em>
+<a name="30" href="#30">30</a>  <em> * the log4j framework.  Each plugin is associated with a specific</em>
+<a name="31" href="#31">31</a>  <em> * LoggerRepository, which it then uses/acts upon.  The functionality</em>
+<a name="32" href="#32">32</a>  <em> * of the plugin is up to the developer.</em>
+<a name="33" href="#33">33</a>  <em> * &lt;p/></em>
+<a name="34" href="#34">34</a>  <em> * &lt;p>Examples of plugins are Receiver and Watchdog. Receiver plugins</em>
+<a name="35" href="#35">35</a>  <em> * allow for remote logging events to be received and processed by</em>
+<a name="36" href="#36">36</a>  <em> * a repository as if the event was sent locally. Watchdog plugins</em>
+<a name="37" href="#37">37</a>  <em> * allow for a repository to be reconfigured when some "watched"</em>
+<a name="38" href="#38">38</a>  <em> * configuration data changes.</em>
+<a name="39" href="#39">39</a>  <em> *</em>
+<a name="40" href="#40">40</a>  <em> * @author Mark Womack (mwomack@apache.org)</em>
+<a name="41" href="#41">41</a>  <em> * @author Nicko Cadell</em>
+<a name="42" href="#42">42</a>  <em> * @author Paul Smith (psmith@apache.org)</em>
+<a name="43" href="#43">43</a>  <em> * @since 1.3</em>
+<a name="44" href="#44">44</a>  <em> */</em>
+<a name="45" href="#45">45</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> <strong>extends</strong> OptionHandler {
+<a name="46" href="#46">46</a>      <em>/**<em>*</em></em>
+<a name="47" href="#47">47</a>  <em>     * Gets the name of the plugin.</em>
+<a name="48" href="#48">48</a>  <em>     *</em>
+<a name="49" href="#49">49</a>  <em>     * @return String the name of the plugin.</em>
+<a name="50" href="#50">50</a>  <em>     */</em>
+<a name="51" href="#51">51</a>      String getName();
+<a name="52" href="#52">52</a>  
+<a name="53" href="#53">53</a>      <em>/**<em>*</em></em>
+<a name="54" href="#54">54</a>  <em>     * Sets the name of the plugin.</em>
+<a name="55" href="#55">55</a>  <em>     *</em>
+<a name="56" href="#56">56</a>  <em>     * @param name the name of the plugin.</em>
+<a name="57" href="#57">57</a>  <em>     */</em>
+<a name="58" href="#58">58</a>      <strong>void</strong> setName(String name);
+<a name="59" href="#59">59</a>  
+<a name="60" href="#60">60</a>      <em>/**<em>*</em></em>
+<a name="61" href="#61">61</a>  <em>     * Gets the logger repository for this plugin.</em>
+<a name="62" href="#62">62</a>  <em>     *</em>
+<a name="63" href="#63">63</a>  <em>     * @return the logger repository to which this plugin is attached.</em>
+<a name="64" href="#64">64</a>  <em>     */</em>
+<a name="65" href="#65">65</a>      LoggerRepository getLoggerRepository();
+<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>     * Sets the logger repository used by this plugin. This</em>
+<a name="69" href="#69">69</a>  <em>     * repository will be used by the plugin functionality.</em>
+<a name="70" href="#70">70</a>  <em>     *</em>
+<a name="71" href="#71">71</a>  <em>     * @param repository the logger repository to attach this plugin to.</em>
+<a name="72" href="#72">72</a>  <em>     */</em>
+<a name="73" href="#73">73</a>      <strong>void</strong> setLoggerRepository(LoggerRepository repository);
+<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>     * Adds a PropertyChangeListener to this instance which is</em>
+<a name="77" href="#77">77</a>  <em>     * notified only by changes of the property with name propertyName.</em>
+<a name="78" href="#78">78</a>  <em>     *</em>
+<a name="79" href="#79">79</a>  <em>     * @param propertyName</em>
+<a name="80" href="#80">80</a>  <em>     *    the name of the property in standard JavaBean syntax</em>
+<a name="81" href="#81">81</a>  <em>     *    (e.g. for setName(), property="name")</em>
+<a name="82" href="#82">82</a>  <em>     * @param l listener</em>
+<a name="83" href="#83">83</a>  <em>     */</em>
+<a name="84" href="#84">84</a>      <strong>void</strong> addPropertyChangeListener(
+<a name="85" href="#85">85</a>              String propertyName, PropertyChangeListener l);
+<a name="86" href="#86">86</a>  
+<a name="87" href="#87">87</a>      <em>/**<em>*</em></em>
+<a name="88" href="#88">88</a>  <em>     * Adds a PropertyChangeListener that will be notified of all property</em>
+<a name="89" href="#89">89</a>  <em>     * changes.</em>
+<a name="90" href="#90">90</a>  <em>     *</em>
+<a name="91" href="#91">91</a>  <em>     * @param l The listener to add.</em>
+<a name="92" href="#92">92</a>  <em>     */</em>
+<a name="93" href="#93">93</a>      <strong>void</strong> addPropertyChangeListener(PropertyChangeListener l);
+<a name="94" href="#94">94</a>  
+<a name="95" href="#95">95</a>      <em>/**<em>*</em></em>
+<a name="96" href="#96">96</a>  <em>     * Removes a specific PropertyChangeListener from this instances</em>
+<a name="97" href="#97">97</a>  <em>     * registry that has been mapped to be notified of all property</em>
+<a name="98" href="#98">98</a>  <em>     * changes.</em>
+<a name="99" href="#99">99</a>  <em>     *</em>
+<a name="100" href="#100">100</a> <em>     * @param l The listener to remove.</em>
+<a name="101" href="#101">101</a> <em>     */</em>
+<a name="102" href="#102">102</a>     <strong>void</strong> removePropertyChangeListener(PropertyChangeListener l);
+<a name="103" href="#103">103</a> 
+<a name="104" href="#104">104</a>     <em>/**<em>*</em></em>
+<a name="105" href="#105">105</a> <em>     * Removes a specific PropertyChangeListener from this instance's</em>
+<a name="106" href="#106">106</a> <em>     * registry which has been previously registered to be notified</em>
+<a name="107" href="#107">107</a> <em>     * of only a specific property change.</em>
+<a name="108" href="#108">108</a> <em>     *</em>
+<a name="109" href="#109">109</a> <em>     * @param propertyName property name, may not be null.</em>
+<a name="110" href="#110">110</a> <em>     * @param l listener to be removed.</em>
+<a name="111" href="#111">111</a> <em>     */</em>
+<a name="112" href="#112">112</a>     <strong>void</strong> removePropertyChangeListener(
+<a name="113" href="#113">113</a>             String propertyName, PropertyChangeListener l);
+<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>     * True if the plugin is active and running.</em>
+<a name="117" href="#117">117</a> <em>     *</em>
+<a name="118" href="#118">118</a> <em>     * @return boolean true if the plugin is currently active.</em>
+<a name="119" href="#119">119</a> <em>     */</em>
+<a name="120" href="#120">120</a>     <strong>boolean</strong> isActive();
+<a name="121" href="#121">121</a> 
+<a name="122" href="#122">122</a>     <em>/**<em>*</em></em>
+<a name="123" href="#123">123</a> <em>     * Returns true if the testPlugin is considered to be "equivalent" to the</em>
+<a name="124" href="#124">124</a> <em>     * this plugin.  The equivalency test is at the discretion of the plugin</em>
+<a name="125" href="#125">125</a> <em>     * implementation.  The PluginRegistry will use this method when starting</em>
+<a name="126" href="#126">126</a> <em>     * new plugins to see if a given plugin is considered equivalent to an</em>
+<a name="127" href="#127">127</a> <em>     * already running plugin with the same name.  If they are considered to</em>
+<a name="128" href="#128">128</a> <em>     * be equivalent, the currently running plugin will be left in place, and</em>
+<a name="129" href="#129">129</a> <em>     * the new plugin will not be started.</em>
+<a name="130" href="#130">130</a> <em>     * &lt;p/></em>
+<a name="131" href="#131">131</a> <em>     * It is possible to override the equals() method, however this has</em>
+<a name="132" href="#132">132</a> <em>     * more meaning than is required for this simple test and would also</em>
+<a name="133" href="#133">133</a> <em>     * require the overriding of the hashCode() method as well.  All of this</em>
+<a name="134" href="#134">134</a> <em>     * is more work than is needed, so this simple method is used instead.</em>
+<a name="135" href="#135">135</a> <em>     *</em>
+<a name="136" href="#136">136</a> <em>     * @param testPlugin The plugin to test equivalency against.</em>
+<a name="137" href="#137">137</a> <em>     * @return Returns true if testPlugin is considered to be equivelent.</em>
+<a name="138" href="#138">138</a> <em>     */</em>
+<a name="139" href="#139">139</a>     <strong>boolean</strong> isEquivalent(<a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> testPlugin);
+<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>     * Call when the plugin should be stopped.</em>
+<a name="143" href="#143">143</a> <em>     */</em>
+<a name="144" href="#144">144</a>     <strong>void</strong> shutdown();
+<a name="145" href="#145">145</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/plugins/Plugin.html
------------------------------------------------------------------------------
    svn:mime-type = text/html



Mime
View raw message