blob: 4afcf5489436768462f320f8c19df64b17fcb54c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.log4j;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.ObjectInputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.ObjectOutputStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.ObjectStreamException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.Serializable;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Locale;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.util.Strings;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Defines the minimum set of levels recognized by the system, that is<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;code&gt;OFF&lt;/code&gt;, &lt;code&gt;FATAL&lt;/code&gt;, &lt;code&gt;ERROR&lt;/code&gt;,<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;code&gt;WARN&lt;/code&gt;, &lt;code&gt;INFO&lt;/code&gt;, &lt;code&gt;DEBUG&lt;/code&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * and &lt;code&gt;ALL&lt;/code&gt;.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * The &lt;code&gt;Level&lt;/code&gt; class may be subclassed to define a larger<a name="line.34"></a>
<span class="sourceLineNo">035</span> * level set.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;/p&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class Level extends Priority implements Serializable {<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * TRACE level integer value.<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @since 1.2.12<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> public static final int TRACE_INT = 5000;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * The &lt;code&gt;OFF&lt;/code&gt; has the highest possible rank and is<a name="line.48"></a>
<span class="sourceLineNo">049</span> * intended to turn off logging.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> public static final Level OFF = new Level(OFF_INT, "OFF", 0);<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * The &lt;code&gt;FATAL&lt;/code&gt; level designates very severe error<a name="line.54"></a>
<span class="sourceLineNo">055</span> * events that will presumably lead the application to abort.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public static final Level FATAL = new Level(FATAL_INT, "FATAL", 0);<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * The &lt;code&gt;ERROR&lt;/code&gt; level designates error events that<a name="line.60"></a>
<span class="sourceLineNo">061</span> * might still allow the application to continue running.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public static final Level ERROR = new Level(ERROR_INT, "ERROR", 3);<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * The &lt;code&gt;WARN&lt;/code&gt; level designates potentially harmful situations.<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public static final Level WARN = new Level(WARN_INT, "WARN", 4);<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * The &lt;code&gt;INFO&lt;/code&gt; level designates informational messages<a name="line.71"></a>
<span class="sourceLineNo">072</span> * that highlight the progress of the application at coarse-grained<a name="line.72"></a>
<span class="sourceLineNo">073</span> * level.<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> public static final Level INFO = new Level(INFO_INT, "INFO", 6);<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
<span class="sourceLineNo">078</span> * The &lt;code&gt;DEBUG&lt;/code&gt; Level designates fine-grained<a name="line.78"></a>
<span class="sourceLineNo">079</span> * informational events that are most useful to debug an<a name="line.79"></a>
<span class="sourceLineNo">080</span> * application.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public static final Level DEBUG = new Level(DEBUG_INT, "DEBUG", 7);<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * The &lt;code&gt;TRACE&lt;/code&gt; Level designates finer-grained<a name="line.85"></a>
<span class="sourceLineNo">086</span> * informational events than the &lt;code&gt;DEBUG&lt;/code&gt; level.<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public static final Level TRACE = new Level(TRACE_INT, "TRACE", 7);<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * The &lt;code&gt;ALL&lt;/code&gt; has the lowest possible rank and is intended to<a name="line.91"></a>
<span class="sourceLineNo">092</span> * turn on all logging.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> public static final Level ALL = new Level(ALL_INT, "ALL", 7);<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Serialization version id.<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> private static final long serialVersionUID = 3491141966387921974L;<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> * Instantiate a Level object.<a name="line.102"></a>
<span class="sourceLineNo">103</span> *<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @param level The logging level.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param levelStr The level name.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param syslogEquivalent The matching syslog level.<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span> protected Level(final int level, final String levelStr, final int syslogEquivalent) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> super(level, levelStr, syslogEquivalent);<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Convert the string passed as argument to a level. If the<a name="line.114"></a>
<span class="sourceLineNo">115</span> * conversion fails, then this method returns {@link #DEBUG}.<a name="line.115"></a>
<span class="sourceLineNo">116</span> *<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @param sArg The level name.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return The Level.<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> public static Level toLevel(final String sArg) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> return toLevel(sArg, Level.DEBUG);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * Convert an integer passed as argument to a level. If the<a name="line.125"></a>
<span class="sourceLineNo">126</span> * conversion fails, then this method returns {@link #DEBUG}.<a name="line.126"></a>
<span class="sourceLineNo">127</span> *<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @param val The integer value of the Level.<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @return The Level.<a name="line.129"></a>
<span class="sourceLineNo">130</span> */<a name="line.130"></a>
<span class="sourceLineNo">131</span> public static Level toLevel(final int val) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return toLevel(val, Level.DEBUG);<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Convert an integer passed as argument to a level. If the<a name="line.136"></a>
<span class="sourceLineNo">137</span> * conversion fails, then this method returns the specified default.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param val The integer value of the Level.<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @param defaultLevel the default level if the integer doesn't match.<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @return The matching Level.<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> public static Level toLevel(final int val, final Level defaultLevel) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> switch (val) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> case ALL_INT:<a name="line.145"></a>
<span class="sourceLineNo">146</span> return ALL;<a name="line.146"></a>
<span class="sourceLineNo">147</span> case DEBUG_INT:<a name="line.147"></a>
<span class="sourceLineNo">148</span> return Level.DEBUG;<a name="line.148"></a>
<span class="sourceLineNo">149</span> case INFO_INT:<a name="line.149"></a>
<span class="sourceLineNo">150</span> return Level.INFO;<a name="line.150"></a>
<span class="sourceLineNo">151</span> case WARN_INT:<a name="line.151"></a>
<span class="sourceLineNo">152</span> return Level.WARN;<a name="line.152"></a>
<span class="sourceLineNo">153</span> case ERROR_INT:<a name="line.153"></a>
<span class="sourceLineNo">154</span> return Level.ERROR;<a name="line.154"></a>
<span class="sourceLineNo">155</span> case FATAL_INT:<a name="line.155"></a>
<span class="sourceLineNo">156</span> return Level.FATAL;<a name="line.156"></a>
<span class="sourceLineNo">157</span> case OFF_INT:<a name="line.157"></a>
<span class="sourceLineNo">158</span> return OFF;<a name="line.158"></a>
<span class="sourceLineNo">159</span> case TRACE_INT:<a name="line.159"></a>
<span class="sourceLineNo">160</span> return Level.TRACE;<a name="line.160"></a>
<span class="sourceLineNo">161</span> default:<a name="line.161"></a>
<span class="sourceLineNo">162</span> return defaultLevel;<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * Convert the string passed as argument to a level. If the<a name="line.167"></a>
<span class="sourceLineNo">168</span> * conversion fails, then this method returns the value of<a name="line.168"></a>
<span class="sourceLineNo">169</span> * &lt;code&gt;defaultLevel&lt;/code&gt;.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @param sArg The name of the Level.<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param defaultLevel The default Level to use.<a name="line.171"></a>
<span class="sourceLineNo">172</span> * @return the matching Level.<a name="line.172"></a>
<span class="sourceLineNo">173</span> */<a name="line.173"></a>
<span class="sourceLineNo">174</span> public static Level toLevel(final String sArg, final Level defaultLevel) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (sArg == null) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return defaultLevel;<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span> final String s = sArg.toUpperCase(Locale.ROOT);<a name="line.178"></a>
<span class="sourceLineNo">179</span> switch (s) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> case "ALL":<a name="line.180"></a>
<span class="sourceLineNo">181</span> return Level.ALL;<a name="line.181"></a>
<span class="sourceLineNo">182</span> case "DEBUG":<a name="line.182"></a>
<span class="sourceLineNo">183</span> return Level.DEBUG;<a name="line.183"></a>
<span class="sourceLineNo">184</span> case "INFO":<a name="line.184"></a>
<span class="sourceLineNo">185</span> return Level.INFO;<a name="line.185"></a>
<span class="sourceLineNo">186</span> case "WARN":<a name="line.186"></a>
<span class="sourceLineNo">187</span> return Level.WARN;<a name="line.187"></a>
<span class="sourceLineNo">188</span> case "ERROR":<a name="line.188"></a>
<span class="sourceLineNo">189</span> return Level.ERROR;<a name="line.189"></a>
<span class="sourceLineNo">190</span> case "FATAL":<a name="line.190"></a>
<span class="sourceLineNo">191</span> return Level.FATAL;<a name="line.191"></a>
<span class="sourceLineNo">192</span> case "OFF":<a name="line.192"></a>
<span class="sourceLineNo">193</span> return Level.OFF;<a name="line.193"></a>
<span class="sourceLineNo">194</span> case "TRACE":<a name="line.194"></a>
<span class="sourceLineNo">195</span> return Level.TRACE;<a name="line.195"></a>
<span class="sourceLineNo">196</span> default:<a name="line.196"></a>
<span class="sourceLineNo">197</span> return defaultLevel;<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> /**<a name="line.201"></a>
<span class="sourceLineNo">202</span> * Custom deserialization of Level.<a name="line.202"></a>
<span class="sourceLineNo">203</span> *<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @param s serialization stream.<a name="line.204"></a>
<span class="sourceLineNo">205</span> * @throws IOException if IO exception.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @throws ClassNotFoundException if class not found.<a name="line.206"></a>
<span class="sourceLineNo">207</span> */<a name="line.207"></a>
<span class="sourceLineNo">208</span> private void readObject(final ObjectInputStream s) throws IOException, ClassNotFoundException {<a name="line.208"></a>
<span class="sourceLineNo">209</span> s.defaultReadObject();<a name="line.209"></a>
<span class="sourceLineNo">210</span> level = s.readInt();<a name="line.210"></a>
<span class="sourceLineNo">211</span> syslogEquivalent = s.readInt();<a name="line.211"></a>
<span class="sourceLineNo">212</span> levelStr = s.readUTF();<a name="line.212"></a>
<span class="sourceLineNo">213</span> if (levelStr == null) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> levelStr = Strings.EMPTY;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> /**<a name="line.218"></a>
<span class="sourceLineNo">219</span> * Serialize level.<a name="line.219"></a>
<span class="sourceLineNo">220</span> *<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @param s serialization stream.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @throws IOException if exception during serialization.<a name="line.222"></a>
<span class="sourceLineNo">223</span> */<a name="line.223"></a>
<span class="sourceLineNo">224</span> private void writeObject(final ObjectOutputStream s) throws IOException {<a name="line.224"></a>
<span class="sourceLineNo">225</span> s.defaultWriteObject();<a name="line.225"></a>
<span class="sourceLineNo">226</span> s.writeInt(level);<a name="line.226"></a>
<span class="sourceLineNo">227</span> s.writeInt(syslogEquivalent);<a name="line.227"></a>
<span class="sourceLineNo">228</span> s.writeUTF(levelStr);<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
<span class="sourceLineNo">232</span> * Resolved deserialized level to one of the stock instances.<a name="line.232"></a>
<span class="sourceLineNo">233</span> * May be overridden in classes derived from Level.<a name="line.233"></a>
<span class="sourceLineNo">234</span> *<a name="line.234"></a>
<span class="sourceLineNo">235</span> * @return resolved object.<a name="line.235"></a>
<span class="sourceLineNo">236</span> * @throws ObjectStreamException if exception during resolution.<a name="line.236"></a>
<span class="sourceLineNo">237</span> */<a name="line.237"></a>
<span class="sourceLineNo">238</span> protected Object readResolve() throws ObjectStreamException {<a name="line.238"></a>
<span class="sourceLineNo">239</span> //<a name="line.239"></a>
<span class="sourceLineNo">240</span> // if the deserialized object is exactly an instance of Level<a name="line.240"></a>
<span class="sourceLineNo">241</span> //<a name="line.241"></a>
<span class="sourceLineNo">242</span> if (getClass() == Level.class) {<a name="line.242"></a>
<span class="sourceLineNo">243</span> return toLevel(level);<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span> //<a name="line.245"></a>
<span class="sourceLineNo">246</span> // extension of Level can't substitute stock item<a name="line.246"></a>
<span class="sourceLineNo">247</span> //<a name="line.247"></a>
<span class="sourceLineNo">248</span> return this;<a name="line.248"></a>
<span class="sourceLineNo">249</span> }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span>}<a name="line.251"></a>
<span class="sourceLineNo">252</span><a name="line.252"></a>
</pre>
</div>
</body>
</html>