| <!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=UTF-8" /> |
| <title>Level xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/logging/log4j/Level.html">View Javadoc</a></div><pre> |
| |
| <a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em> |
| <a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j; |
| <a class="jxr_linenumber" name="18" href="#18">18</a> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * Levels used for identifying the severity of an event. Levels are organized from most specific to least:<br></em> |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * OFF (most specific)<br></em> |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * FATAL<br></em> |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * ERROR<br></em> |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * WARN<br></em> |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * INFO<br></em> |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * DEBUG<br></em> |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * TRACE<br></em> |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * AL (least specific)<br></em> |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Typically, configuring a level in a filter or on a logger will cause logging events of that level and those</em> |
| <a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * that are more specific to pass through the filter.</em> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * A special level, ALL, is guaranteed to capture all levels when used in logging configurations.</em> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../org/apache/logging/log4j/Level.html">Level</a> { |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * No events will be logged.</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> OFF(0), |
| <a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * A severe error that will prevent the application from continuing.</em> |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> FATAL(1), |
| <a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * An error in the application, possibly recoverable.</em> |
| <a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="46" href="#46">46</a> ERROR(2), |
| <a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * An event that might possible lead to an error.</em> |
| <a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="50" href="#50">50</a> WARN(3), |
| <a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * An event for informational purposes.</em> |
| <a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> INFO(4), |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * A general debugging event.</em> |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="58" href="#58">58</a> DEBUG(5), |
| <a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * A fine-grained debug message, typically capturing the flow through the application.</em> |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="62" href="#62">62</a> TRACE(6), |
| <a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * All events should be logged.</em> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="66" href="#66">66</a> ALL(Integer.MAX_VALUE); |
| <a class="jxr_linenumber" name="67" href="#67">67</a> |
| <a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> intLevel; |
| <a class="jxr_linenumber" name="69" href="#69">69</a> |
| <a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/logging/log4j/Level.html">Level</a>(<strong class="jxr_keyword">int</strong> val) { |
| <a class="jxr_linenumber" name="71" href="#71">71</a> intLevel = val; |
| <a class="jxr_linenumber" name="72" href="#72">72</a> } |
| <a class="jxr_linenumber" name="73" href="#73">73</a> |
| <a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Convert the string passed as argument to a level. If the</em> |
| <a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * conversion fails, then this method returns {@link #DEBUG}.</em> |
| <a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param sArg The name of the desired Level.</em> |
| <a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @return The Level associated with the String.</em> |
| <a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/logging/log4j/Level.html">Level</a> toLevel(String sArg) { |
| <a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> toLevel(sArg, DEBUG); |
| <a class="jxr_linenumber" name="83" href="#83">83</a> } |
| <a class="jxr_linenumber" name="84" href="#84">84</a> |
| <a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Convert the string passed as argument to a level. If the</em> |
| <a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * conversion fails, then this method returns the value of</em> |
| <a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <code>defaultLevel</code>.</em> |
| <a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @param sArg The name of the desired Level.</em> |
| <a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param defaultLevel The Level to use if the String is invalid.</em> |
| <a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @return The LEvel associated with the String.</em> |
| <a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/logging/log4j/Level.html">Level</a> toLevel(String sArg, <a href="../../../../org/apache/logging/log4j/Level.html">Level</a> defaultLevel) { |
| <a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> (sArg == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> defaultLevel; |
| <a class="jxr_linenumber" name="97" href="#97">97</a> } |
| <a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">for</strong> (Level level : values()) { |
| <a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (level.name().equals(sArg)) { |
| <a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">return</strong> level; |
| <a class="jxr_linenumber" name="101" href="#101">101</a> } |
| <a class="jxr_linenumber" name="102" href="#102">102</a> } |
| <a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">return</strong> defaultLevel; |
| <a class="jxr_linenumber" name="104" href="#104">104</a> } |
| <a class="jxr_linenumber" name="105" href="#105">105</a> |
| <a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Compares this level against the level passed as an argument and returns true if this</em> |
| <a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * level is the same or more specific.</em> |
| <a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @param level The level to check.</em> |
| <a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @return True if the passed Level is more specific or the same as this Level.</em> |
| <a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAtLeastAsSpecificAs(<a href="../../../../org/apache/logging/log4j/Level.html">Level</a> level) { |
| <a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">return</strong> (intLevel <= level.intLevel); |
| <a class="jxr_linenumber" name="115" href="#115">115</a> } |
| <a class="jxr_linenumber" name="116" href="#116">116</a> |
| <a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Compares this level against the level passed as an argument and returns true if this</em> |
| <a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * level is the same or more specific.</em> |
| <a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param level The level to check.</em> |
| <a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @return True if the passed Level is more specific or the same as this Level.</em> |
| <a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAtLeastAsSpecificAs(<strong class="jxr_keyword">int</strong> level) { |
| <a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">return</strong> (intLevel <= level); |
| <a class="jxr_linenumber" name="126" href="#126">126</a> } |
| <a class="jxr_linenumber" name="127" href="#127">127</a> |
| <a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * Compares the specified Level against this one.</em> |
| <a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @param level The level to check.</em> |
| <a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @return True if the passed Level is more specific or the same as this Level.</em> |
| <a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> lessOrEqual(<a href="../../../../org/apache/logging/log4j/Level.html">Level</a> level) { |
| <a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> (intLevel <= level.intLevel); |
| <a class="jxr_linenumber" name="135" href="#135">135</a> } |
| <a class="jxr_linenumber" name="136" href="#136">136</a> |
| <a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Compares the specified Level against this one.</em> |
| <a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @param level The level to check.</em> |
| <a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @return True if the passed Level is more specific or the same as this Level.</em> |
| <a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> lessOrEqual(<strong class="jxr_keyword">int</strong> level) { |
| <a class="jxr_linenumber" name="143" href="#143">143</a> <strong class="jxr_keyword">return</strong> (intLevel <= level); |
| <a class="jxr_linenumber" name="144" href="#144">144</a> } |
| <a class="jxr_linenumber" name="145" href="#145">145</a> |
| <a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Returns the integer value of the Level.</em> |
| <a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @return the integer value of the Level.</em> |
| <a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> intLevel() { |
| <a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> intLevel; |
| <a class="jxr_linenumber" name="152" href="#152">152</a> } |
| <a class="jxr_linenumber" 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> |
| |
