PageRenderTime 40ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/apache-log4j-1.2.17/site/xref/org/apache/log4j/spi/OptionHandler.html

#
HTML | 76 lines | 74 code | 2 blank | 0 comment | 0 complexity | dbb5a4dd5c0213d54ab1a47b70c1c79e MD5 | raw file
Possible License(s): Apache-2.0
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  3. <head>
  4. <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
  5. <title>OptionHandler xref</title>
  6. <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
  7. </head>
  8. <body>
  9. <div id="overview"><a href="../../../../../apidocs/org/apache/log4j/spi/OptionHandler.html">View Javadoc</a></div><pre>
  10. <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
  11. <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
  12. <a name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
  13. <a name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
  14. <a name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
  15. <a name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
  16. <a name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
  17. <a name="8" href="#8">8</a> <em class="jxr_comment"> * </em>
  18. <a name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
  19. <a name="10" href="#10">10</a> <em class="jxr_comment"> * </em>
  20. <a name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
  21. <a name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
  22. <a name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
  23. <a name="14" href="#14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
  24. <a name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the License.</em>
  25. <a name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
  26. <a name="17" href="#17">17</a>
  27. <a name="18" href="#18">18</a> <strong class="jxr_keyword">package</strong> org.apache.log4j.spi;
  28. <a name="19" href="#19">19</a>
  29. <a name="20" href="#20">20</a>
  30. <a name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em>
  31. <a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> A string based interface to configure package components.</em>
  32. <a name="23" href="#23">23</a>
  33. <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> @author Ceki G&amp;uuml;lc&amp;uuml;</em>
  34. <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> @author Anders Kristensen</em>
  35. <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> @since 0.8.1</em>
  36. <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> */</em>
  37. <a name="28" href="#28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/log4j/spi/OptionHandler.html">OptionHandler</a> {
  38. <a name="29" href="#29">29</a>
  39. <a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
  40. <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> Activate the options that were previously set with calls to option</em>
  41. <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> setters.</em>
  42. <a name="33" href="#33">33</a>
  43. <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> &lt;p&gt;This allows to defer activiation of the options until all</em>
  44. <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> options have been set. This is required for components which have</em>
  45. <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> related options that remain ambigous until all are set.</em>
  46. <a name="37" href="#37">37</a>
  47. <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> &lt;p&gt;For example, the FileAppender has the {@link</em>
  48. <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> org.apache.log4j.FileAppender#setFile File} and {@link</em>
  49. <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> org.apache.log4j.FileAppender#setAppend Append} options both of</em>
  50. <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> which are ambigous until the other is also set. */</em>
  51. <a name="42" href="#42">42</a> <strong class="jxr_keyword">void</strong> activateOptions();
  52. <a name="43" href="#43">43</a>
  53. <a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
  54. <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> Return list of strings that the OptionHandler instance recognizes.</em>
  55. <a name="46" href="#46">46</a>
  56. <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> @deprecated We now use JavaBeans style getters/setters.</em>
  57. <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
  58. <a name="49" href="#49">49</a> <em class="jxr_comment">// String[] getOptionStrings();</em>
  59. <a name="50" href="#50">50</a>
  60. <a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
  61. <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> Set &lt;code&gt;option&lt;/code&gt; to &lt;code&gt;value&lt;/code&gt;.</em>
  62. <a name="53" href="#53">53</a>
  63. <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> &lt;p&gt;The handling of each option depends on the OptionHandler</em>
  64. <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> instance. Some options may become active immediately whereas</em>
  65. <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> other may be activated only when {@link #activateOptions} is</em>
  66. <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> called.</em>
  67. <a name="58" href="#58">58</a>
  68. <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> @deprecated We now use JavaBeans style getters/setters.</em>
  69. <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
  70. <a name="61" href="#61">61</a> <em class="jxr_comment">//void setOption(String option, String value);</em>
  71. <a name="62" href="#62">62</a> }
  72. </pre>
  73. <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
  74. </html>