Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.3 / log4j-1.2-api / apidocs / src-html / org / apache / log4j / Priority.html
blob: 1d4a38d41f402f36b64caa122ec0752eaad7016b [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>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;em style="color:#A44"&gt;Refrain from using this class directly, use<a name="line.20"></a>
<span class="sourceLineNo">021</span> * the {@link Level} class instead.&lt;/em&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> */<a name="line.22"></a>
<span class="sourceLineNo">023</span>public class Priority {<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span> /**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * The &lt;code&gt;OFF&lt;/code&gt; has the highest possible rank and is<a name="line.26"></a>
<span class="sourceLineNo">027</span> * intended to turn off logging.<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span> public static final int OFF_INT = Integer.MAX_VALUE;<a name="line.29"></a>
<span class="sourceLineNo">030</span> /**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * The &lt;code&gt;FATAL&lt;/code&gt; level designates very severe error<a name="line.31"></a>
<span class="sourceLineNo">032</span> * events that will presumably lead the application to abort.<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span> public static final int FATAL_INT = 50000;<a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * The &lt;code&gt;ERROR&lt;/code&gt; level designates error events that<a name="line.36"></a>
<span class="sourceLineNo">037</span> * might still allow the application to continue running.<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span> public static final int ERROR_INT = 40000;<a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * The &lt;code&gt;WARN&lt;/code&gt; level designates potentially harmful situations.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> public static final int WARN_INT = 30000;<a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * The &lt;code&gt;INFO&lt;/code&gt; level designates informational messages<a name="line.45"></a>
<span class="sourceLineNo">046</span> * that highlight the progress of the application at coarse-grained<a name="line.46"></a>
<span class="sourceLineNo">047</span> * level.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> public static final int INFO_INT = 20000;<a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * The &lt;code&gt;DEBUG&lt;/code&gt; Level designates fine-grained<a name="line.51"></a>
<span class="sourceLineNo">052</span> * informational events that are most useful to debug an<a name="line.52"></a>
<span class="sourceLineNo">053</span> * application.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static final int DEBUG_INT = 10000;<a name="line.55"></a>
<span class="sourceLineNo">056</span> //public final static int FINE_INT = DEBUG_INT;<a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * The &lt;code&gt;ALL&lt;/code&gt; has the lowest possible rank and is intended to<a name="line.58"></a>
<span class="sourceLineNo">059</span> * turn on all logging.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public static final int ALL_INT = Integer.MIN_VALUE;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @deprecated Use {@link Level#FATAL} instead.<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span> @Deprecated<a name="line.66"></a>
<span class="sourceLineNo">067</span> public static final Priority FATAL = new Level(FATAL_INT, "FATAL", 0);<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @deprecated Use {@link Level#ERROR} instead.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> @Deprecated<a name="line.72"></a>
<span class="sourceLineNo">073</span> public static final Priority ERROR = new Level(ERROR_INT, "ERROR", 3);<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @deprecated Use {@link Level#WARN} instead.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> @Deprecated<a name="line.78"></a>
<span class="sourceLineNo">079</span> public static final Priority WARN = new Level(WARN_INT, "WARN", 4);<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @deprecated Use {@link Level#INFO} instead.<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> @Deprecated<a name="line.84"></a>
<span class="sourceLineNo">085</span> public static final Priority INFO = new Level(INFO_INT, "INFO", 6);<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @deprecated Use {@link Level#DEBUG} instead.<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> @Deprecated<a name="line.90"></a>
<span class="sourceLineNo">091</span> public static final Priority DEBUG = new Level(DEBUG_INT, "DEBUG", 7);<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> /*<a name="line.93"></a>
<span class="sourceLineNo">094</span> * These variables should be private but were not in Log4j 1.2 so are left the same way here.<a name="line.94"></a>
<span class="sourceLineNo">095</span> */<a name="line.95"></a>
<span class="sourceLineNo">096</span> transient int level;<a name="line.96"></a>
<span class="sourceLineNo">097</span> transient String levelStr;<a name="line.97"></a>
<span class="sourceLineNo">098</span> transient int syslogEquivalent;<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * Default constructor for deserialization.<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> protected Priority() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> level = DEBUG_INT;<a name="line.104"></a>
<span class="sourceLineNo">105</span> levelStr = "DEBUG";<a name="line.105"></a>
<span class="sourceLineNo">106</span> syslogEquivalent = 7;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
<span class="sourceLineNo">110</span> * Instantiate a level object.<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @param level The level value.<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @param levelStr The level name.<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param syslogEquivalent The equivalent syslog value.<a name="line.113"></a>
<span class="sourceLineNo">114</span> */<a name="line.114"></a>
<span class="sourceLineNo">115</span> protected Priority(final int level, final String levelStr, final int syslogEquivalent) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> this.level = level;<a name="line.116"></a>
<span class="sourceLineNo">117</span> this.levelStr = levelStr;<a name="line.117"></a>
<span class="sourceLineNo">118</span> this.syslogEquivalent = syslogEquivalent;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Two priorities are equal if their level fields are equal.<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @param o The Object to check.<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @return true if the objects are equal, false otherwise.<a name="line.124"></a>
<span class="sourceLineNo">125</span> *<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @since 1.2<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> @Override<a name="line.128"></a>
<span class="sourceLineNo">129</span> public boolean equals(final Object o) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> if (o instanceof Priority) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> final Priority r = (Priority) o;<a name="line.131"></a>
<span class="sourceLineNo">132</span> return this.level == r.level;<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> return false;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> @Override<a name="line.137"></a>
<span class="sourceLineNo">138</span> public int hashCode() {<a name="line.138"></a>
<span class="sourceLineNo">139</span> return this.level;<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> /**<a name="line.142"></a>
<span class="sourceLineNo">143</span> * Returns the syslog equivalent of this priority as an integer.<a name="line.143"></a>
<span class="sourceLineNo">144</span> * @return The equivalent syslog value.<a name="line.144"></a>
<span class="sourceLineNo">145</span> */<a name="line.145"></a>
<span class="sourceLineNo">146</span> public<a name="line.146"></a>
<span class="sourceLineNo">147</span> final int getSyslogEquivalent() {<a name="line.147"></a>
<span class="sourceLineNo">148</span> return syslogEquivalent;<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> /**<a name="line.152"></a>
<span class="sourceLineNo">153</span> * Returns {@code true} if this level has a higher or equal<a name="line.153"></a>
<span class="sourceLineNo">154</span> * level than the level passed as argument, {@code false}<a name="line.154"></a>
<span class="sourceLineNo">155</span> * otherwise.<a name="line.155"></a>
<span class="sourceLineNo">156</span> * &lt;p&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span> * You should think twice before overriding the default<a name="line.157"></a>
<span class="sourceLineNo">158</span> * implementation of &lt;code&gt;isGreaterOrEqual&lt;/code&gt; method.<a name="line.158"></a>
<span class="sourceLineNo">159</span> * &lt;/p&gt;<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @param r The Priority to check.<a name="line.160"></a>
<span class="sourceLineNo">161</span> * @return true if the current level is greater or equal to the specified Priority.<a name="line.161"></a>
<span class="sourceLineNo">162</span> */<a name="line.162"></a>
<span class="sourceLineNo">163</span> public boolean isGreaterOrEqual(final Priority r) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> return level &gt;= r.level;<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> /**<a name="line.167"></a>
<span class="sourceLineNo">168</span> * Returns all possible priorities as an array of Level objects in<a name="line.168"></a>
<span class="sourceLineNo">169</span> * descending order.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @return An array of all possible Priorities.<a name="line.170"></a>
<span class="sourceLineNo">171</span> *<a name="line.171"></a>
<span class="sourceLineNo">172</span> * @deprecated This method will be removed with no replacement.<a name="line.172"></a>
<span class="sourceLineNo">173</span> */<a name="line.173"></a>
<span class="sourceLineNo">174</span> @Deprecated<a name="line.174"></a>
<span class="sourceLineNo">175</span> public static Priority[] getAllPossiblePriorities() {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return new Priority[]{Priority.FATAL, Priority.ERROR, Level.WARN,<a name="line.176"></a>
<span class="sourceLineNo">177</span> Priority.INFO, Priority.DEBUG};<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> /**<a name="line.181"></a>
<span class="sourceLineNo">182</span> * Returns the string representation of this priority.<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @return The name of the Priority.<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span> public final String toString() {<a name="line.186"></a>
<span class="sourceLineNo">187</span> return levelStr;<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Returns the integer representation of this level.<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @return The integer value of this level.<a name="line.192"></a>
<span class="sourceLineNo">193</span> */<a name="line.193"></a>
<span class="sourceLineNo">194</span> public final int toInt() {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return level;<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> /**<a name="line.198"></a>
<span class="sourceLineNo">199</span> * @param sArg The name of the Priority.<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @return The Priority matching the name.<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @deprecated Please use the {@link Level#toLevel(String)} method instead.<a name="line.201"></a>
<span class="sourceLineNo">202</span> */<a name="line.202"></a>
<span class="sourceLineNo">203</span> @Deprecated<a name="line.203"></a>
<span class="sourceLineNo">204</span> public static Priority toPriority(final String sArg) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> return Level.toLevel(sArg);<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span><a name="line.207"></a>
<span class="sourceLineNo">208</span> /**<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @param val The value of the Priority.<a name="line.209"></a>
<span class="sourceLineNo">210</span> * @return The Priority matching the value.<a name="line.210"></a>
<span class="sourceLineNo">211</span> * @deprecated Please use the {@link Level#toLevel(int)} method instead.<a name="line.211"></a>
<span class="sourceLineNo">212</span> */<a name="line.212"></a>
<span class="sourceLineNo">213</span> @Deprecated<a name="line.213"></a>
<span class="sourceLineNo">214</span> public static Priority toPriority(final int val) {<a name="line.214"></a>
<span class="sourceLineNo">215</span> return toPriority(val, Priority.DEBUG);<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> * @param val The value of the Priority.<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @param defaultPriority The default Priority to use if the value is invalid.<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @return The Priority matching the value or the default Priority if no match is found.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @deprecated Please use the {@link Level#toLevel(int, Level)} method instead.<a name="line.222"></a>
<span class="sourceLineNo">223</span> */<a name="line.223"></a>
<span class="sourceLineNo">224</span> @Deprecated<a name="line.224"></a>
<span class="sourceLineNo">225</span> public static Priority toPriority(final int val, final Priority defaultPriority) {<a name="line.225"></a>
<span class="sourceLineNo">226</span> return Level.toLevel(val, (Level) defaultPriority);<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> /**<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @param sArg The name of the Priority.<a name="line.230"></a>
<span class="sourceLineNo">231</span> * @param defaultPriority The default Priority to use if the name is not found.<a name="line.231"></a>
<span class="sourceLineNo">232</span> * @return The Priority matching the name or the default Priority if no match is found.<a name="line.232"></a>
<span class="sourceLineNo">233</span> * @deprecated Please use the {@link Level#toLevel(String, Level)} method instead.<a name="line.233"></a>
<span class="sourceLineNo">234</span> */<a name="line.234"></a>
<span class="sourceLineNo">235</span> @Deprecated<a name="line.235"></a>
<span class="sourceLineNo">236</span> public static Priority toPriority(final String sArg, final Priority defaultPriority) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> return Level.toLevel(sArg, (Level) defaultPriority);<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span>}<a name="line.239"></a>
</pre>
</div>
</body>
</html>