| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <FONT color="green">008</FONT> *<a name="line.8"></a> |
| <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <FONT color="green">010</FONT> *<a name="line.10"></a> |
| <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a> |
| <FONT color="green">016</FONT> */<a name="line.16"></a> |
| <FONT color="green">017</FONT> package org.apache.logging.log4j;<a name="line.17"></a> |
| <FONT color="green">018</FONT> <a name="line.18"></a> |
| <FONT color="green">019</FONT> import org.apache.logging.log4j.message.Message;<a name="line.19"></a> |
| <FONT color="green">020</FONT> import org.apache.logging.log4j.message.MessageFactory;<a name="line.20"></a> |
| <FONT color="green">021</FONT> <a name="line.21"></a> |
| <FONT color="green">022</FONT> /**<a name="line.22"></a> |
| <FONT color="green">023</FONT> * This is the central interface in the log4j package. Most logging operations, except configuration, are done through<a name="line.23"></a> |
| <FONT color="green">024</FONT> * this interface.<a name="line.24"></a> |
| <FONT color="green">025</FONT> *<a name="line.25"></a> |
| <FONT color="green">026</FONT> * <p><a name="line.26"></a> |
| <FONT color="green">027</FONT> * The canonical way to obtain a Logger for a class is through {@link LogManager#getLogger()}. Typically, each class<a name="line.27"></a> |
| <FONT color="green">028</FONT> * gets its own Logger named after its fully qualified class name (the default Logger name when obtained through the<a name="line.28"></a> |
| <FONT color="green">029</FONT> * {@link LogManager#getLogger()} method). Thus, the simplest way to use this would be like so:<a name="line.29"></a> |
| <FONT color="green">030</FONT> * </p><a name="line.30"></a> |
| <FONT color="green">031</FONT> * <a name="line.31"></a> |
| <FONT color="green">032</FONT> * <pre><a name="line.32"></a> |
| <FONT color="green">033</FONT> * public class MyClass {<a name="line.33"></a> |
| <FONT color="green">034</FONT> * private static final Logger LOGGER = LogManager.getLogger();<a name="line.34"></a> |
| <FONT color="green">035</FONT> * // ...<a name="line.35"></a> |
| <FONT color="green">036</FONT> * }<a name="line.36"></a> |
| <FONT color="green">037</FONT> * </pre><a name="line.37"></a> |
| <FONT color="green">038</FONT> * <p><a name="line.38"></a> |
| <FONT color="green">039</FONT> * For ease of filtering, searching, sorting, etc., it is generally a good idea to create Loggers for each class rather<a name="line.39"></a> |
| <FONT color="green">040</FONT> * than sharing Loggers. Instead, {@link Marker Markers} should be used for shared, filterable identification.<a name="line.40"></a> |
| <FONT color="green">041</FONT> * </p><a name="line.41"></a> |
| <FONT color="green">042</FONT> * <p><a name="line.42"></a> |
| <FONT color="green">043</FONT> * For service provider implementations, it is recommended to extend the<a name="line.43"></a> |
| <FONT color="green">044</FONT> * {@link org.apache.logging.log4j.spi.AbstractLogger} class rather than implementing this interface directly.<a name="line.44"></a> |
| <FONT color="green">045</FONT> * </p><a name="line.45"></a> |
| <FONT color="green">046</FONT> */<a name="line.46"></a> |
| <FONT color="green">047</FONT> public interface LevelLogger {<a name="line.47"></a> |
| <FONT color="green">048</FONT> <a name="line.48"></a> |
| <FONT color="green">049</FONT> /**<a name="line.49"></a> |
| <FONT color="green">050</FONT> * Logs an exception or error that has been caught. Normally, one may wish to provide additional information with an<a name="line.50"></a> |
| <FONT color="green">051</FONT> * exception while logging it; in these cases, one would not use this method. In other cases where simply logging<a name="line.51"></a> |
| <FONT color="green">052</FONT> * the fact that an exception was swallowed somewhere (e.g., at the top of the stack trace in a {@code main()}<a name="line.52"></a> |
| <FONT color="green">053</FONT> * method), this method is ideal for it.<a name="line.53"></a> |
| <FONT color="green">054</FONT> *<a name="line.54"></a> |
| <FONT color="green">055</FONT> * @param t<a name="line.55"></a> |
| <FONT color="green">056</FONT> * The Throwable.<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> void catching(Throwable t);<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * Logs entry to a method. Used when the method in question has no parameters or when the parameters should not be<a name="line.61"></a> |
| <FONT color="green">062</FONT> * logged.<a name="line.62"></a> |
| <FONT color="green">063</FONT> */<a name="line.63"></a> |
| <FONT color="green">064</FONT> void entry();<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> /**<a name="line.66"></a> |
| <FONT color="green">067</FONT> * Logs entry to a method along with its parameters. For example,<a name="line.67"></a> |
| <FONT color="green">068</FONT> * <a name="line.68"></a> |
| <FONT color="green">069</FONT> * <pre><a name="line.69"></a> |
| <FONT color="green">070</FONT> * public void doSomething(String foo, int bar) {<a name="line.70"></a> |
| <FONT color="green">071</FONT> * LOGGER.entry(foo, bar);<a name="line.71"></a> |
| <FONT color="green">072</FONT> * // do something<a name="line.72"></a> |
| <FONT color="green">073</FONT> * }<a name="line.73"></a> |
| <FONT color="green">074</FONT> * </pre><a name="line.74"></a> |
| <FONT color="green">075</FONT> * <p><a name="line.75"></a> |
| <FONT color="green">076</FONT> * The use of methods such as this are more effective when combined with aspect-oriented programming or other<a name="line.76"></a> |
| <FONT color="green">077</FONT> * bytecode manipulation tools. It can be rather tedious (and messy) to use this type of method manually.<a name="line.77"></a> |
| <FONT color="green">078</FONT> * </p><a name="line.78"></a> |
| <FONT color="green">079</FONT> *<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @param params<a name="line.80"></a> |
| <FONT color="green">081</FONT> * The parameters to the method. TODO Use of varargs results in array creation which can be a substantial<a name="line.81"></a> |
| <FONT color="green">082</FONT> * portion of no-op case. LogMF/LogSF provides several overrides to avoid vararg except in edge cases. (RG)<a name="line.82"></a> |
| <FONT color="green">083</FONT> * LogMF and LogSF implement these in LogXF which calls logger.callAppenders. callAppenders is part of the<a name="line.83"></a> |
| <FONT color="green">084</FONT> * implementation and cannot be used by the API. Adding more methods here and in AbstractLogger is<a name="line.84"></a> |
| <FONT color="green">085</FONT> * sufficient.<a name="line.85"></a> |
| <FONT color="green">086</FONT> */<a name="line.86"></a> |
| <FONT color="green">087</FONT> void entry(Object... params);<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> /**<a name="line.89"></a> |
| <FONT color="green">090</FONT> * Logs exit from a method. Used for methods that do not return anything.<a name="line.90"></a> |
| <FONT color="green">091</FONT> */<a name="line.91"></a> |
| <FONT color="green">092</FONT> void exit();<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> /**<a name="line.94"></a> |
| <FONT color="green">095</FONT> * Logs exiting from a method with the result. This may be coded as:<a name="line.95"></a> |
| <FONT color="green">096</FONT> * <a name="line.96"></a> |
| <FONT color="green">097</FONT> * <pre><a name="line.97"></a> |
| <FONT color="green">098</FONT> * return LOGGER.exit(myResult);<a name="line.98"></a> |
| <FONT color="green">099</FONT> * </pre><a name="line.99"></a> |
| <FONT color="green">100</FONT> *<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @param <R><a name="line.101"></a> |
| <FONT color="green">102</FONT> * The type of the parameter and object being returned.<a name="line.102"></a> |
| <FONT color="green">103</FONT> * @param result<a name="line.103"></a> |
| <FONT color="green">104</FONT> * The result being returned from the method call.<a name="line.104"></a> |
| <FONT color="green">105</FONT> * @return the result.<a name="line.105"></a> |
| <FONT color="green">106</FONT> */<a name="line.106"></a> |
| <FONT color="green">107</FONT> <R> R exit(R result);<a name="line.107"></a> |
| <FONT color="green">108</FONT> <a name="line.108"></a> |
| <FONT color="green">109</FONT> /**<a name="line.109"></a> |
| <FONT color="green">110</FONT> * Gets the Level associated with the Logger.<a name="line.110"></a> |
| <FONT color="green">111</FONT> *<a name="line.111"></a> |
| <FONT color="green">112</FONT> * @return the Level associate with the Logger.<a name="line.112"></a> |
| <FONT color="green">113</FONT> */<a name="line.113"></a> |
| <FONT color="green">114</FONT> Level getLevel();<a name="line.114"></a> |
| <FONT color="green">115</FONT> <a name="line.115"></a> |
| <FONT color="green">116</FONT> /**<a name="line.116"></a> |
| <FONT color="green">117</FONT> * Gets the message factory used to convert message Objects and Strings into actual log Messages.<a name="line.117"></a> |
| <FONT color="green">118</FONT> *<a name="line.118"></a> |
| <FONT color="green">119</FONT> * @return the message factory.<a name="line.119"></a> |
| <FONT color="green">120</FONT> */<a name="line.120"></a> |
| <FONT color="green">121</FONT> MessageFactory getMessageFactory();<a name="line.121"></a> |
| <FONT color="green">122</FONT> <a name="line.122"></a> |
| <FONT color="green">123</FONT> /**<a name="line.123"></a> |
| <FONT color="green">124</FONT> * Gets the logger name.<a name="line.124"></a> |
| <FONT color="green">125</FONT> *<a name="line.125"></a> |
| <FONT color="green">126</FONT> * @return the logger name.<a name="line.126"></a> |
| <FONT color="green">127</FONT> */<a name="line.127"></a> |
| <FONT color="green">128</FONT> String getName();<a name="line.128"></a> |
| <FONT color="green">129</FONT> <a name="line.129"></a> |
| <FONT color="green">130</FONT> /**<a name="line.130"></a> |
| <FONT color="green">131</FONT> * Checks whether this Logger is enabled for the {@link Level#DEBUG DEBUG} Level.<a name="line.131"></a> |
| <FONT color="green">132</FONT> *<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @return boolean - {@code true} if this Logger is enabled for level DEBUG, {@code false} otherwise.<a name="line.133"></a> |
| <FONT color="green">134</FONT> */<a name="line.134"></a> |
| <FONT color="green">135</FONT> boolean isDebugEnabled();<a name="line.135"></a> |
| <FONT color="green">136</FONT> <a name="line.136"></a> |
| <FONT color="green">137</FONT> /**<a name="line.137"></a> |
| <FONT color="green">138</FONT> * Checks whether this Logger is enabled for the {@link Level#DEBUG DEBUG} Level.<a name="line.138"></a> |
| <FONT color="green">139</FONT> *<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @param marker<a name="line.140"></a> |
| <FONT color="green">141</FONT> * The marker data specific to this log statement.<a name="line.141"></a> |
| <FONT color="green">142</FONT> * @return boolean - {@code true} if this Logger is enabled for level DEBUG, {@code false} otherwise.<a name="line.142"></a> |
| <FONT color="green">143</FONT> */<a name="line.143"></a> |
| <FONT color="green">144</FONT> boolean isDebugEnabled(Marker marker);<a name="line.144"></a> |
| <FONT color="green">145</FONT> <a name="line.145"></a> |
| <FONT color="green">146</FONT> /**<a name="line.146"></a> |
| <FONT color="green">147</FONT> * Checks whether this Logger is enabled for the the given Level.<a name="line.147"></a> |
| <FONT color="green">148</FONT> * <p><a name="line.148"></a> |
| <FONT color="green">149</FONT> * Note that passing in {@link Level#OFF OFF} always returns {@code true}.<a name="line.149"></a> |
| <FONT color="green">150</FONT> * </p><a name="line.150"></a> |
| <FONT color="green">151</FONT> *<a name="line.151"></a> |
| <FONT color="green">152</FONT> * @return boolean - {@code true} if this Logger is enabled for level, {@code false} otherwise.<a name="line.152"></a> |
| <FONT color="green">153</FONT> */<a name="line.153"></a> |
| <FONT color="green">154</FONT> boolean isEnabled(Level level);<a name="line.154"></a> |
| <FONT color="green">155</FONT> <a name="line.155"></a> |
| <FONT color="green">156</FONT> /**<a name="line.156"></a> |
| <FONT color="green">157</FONT> * Checks whether this logger is enabled at the specified level and an optional Marker.<a name="line.157"></a> |
| <FONT color="green">158</FONT> *<a name="line.158"></a> |
| <FONT color="green">159</FONT> * @param marker<a name="line.159"></a> |
| <FONT color="green">160</FONT> * The marker data specific to this log statement.<a name="line.160"></a> |
| <FONT color="green">161</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#WARN WARN}, {@code false}<a name="line.161"></a> |
| <FONT color="green">162</FONT> * otherwise.<a name="line.162"></a> |
| <FONT color="green">163</FONT> */<a name="line.163"></a> |
| <FONT color="green">164</FONT> boolean isEnabled(Marker marker);<a name="line.164"></a> |
| <FONT color="green">165</FONT> <a name="line.165"></a> |
| <FONT color="green">166</FONT> /**<a name="line.166"></a> |
| <FONT color="green">167</FONT> * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level.<a name="line.167"></a> |
| <FONT color="green">168</FONT> *<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#ERROR ERROR}, {@code false}<a name="line.169"></a> |
| <FONT color="green">170</FONT> * otherwise.<a name="line.170"></a> |
| <FONT color="green">171</FONT> */<a name="line.171"></a> |
| <FONT color="green">172</FONT> boolean isErrorEnabled();<a name="line.172"></a> |
| <FONT color="green">173</FONT> <a name="line.173"></a> |
| <FONT color="green">174</FONT> /**<a name="line.174"></a> |
| <FONT color="green">175</FONT> * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level.<a name="line.175"></a> |
| <FONT color="green">176</FONT> *<a name="line.176"></a> |
| <FONT color="green">177</FONT> * @param marker<a name="line.177"></a> |
| <FONT color="green">178</FONT> * The marker data specific to this log statement.<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#ERROR ERROR}, {@code false}<a name="line.179"></a> |
| <FONT color="green">180</FONT> * otherwise.<a name="line.180"></a> |
| <FONT color="green">181</FONT> */<a name="line.181"></a> |
| <FONT color="green">182</FONT> boolean isErrorEnabled(Marker marker);<a name="line.182"></a> |
| <FONT color="green">183</FONT> <a name="line.183"></a> |
| <FONT color="green">184</FONT> /**<a name="line.184"></a> |
| <FONT color="green">185</FONT> * Checks whether this Logger is enabled for the {@link Level#FATAL FATAL} Level.<a name="line.185"></a> |
| <FONT color="green">186</FONT> *<a name="line.186"></a> |
| <FONT color="green">187</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#FATAL FATAL}, {@code false}<a name="line.187"></a> |
| <FONT color="green">188</FONT> * otherwise.<a name="line.188"></a> |
| <FONT color="green">189</FONT> */<a name="line.189"></a> |
| <FONT color="green">190</FONT> boolean isFatalEnabled();<a name="line.190"></a> |
| <FONT color="green">191</FONT> <a name="line.191"></a> |
| <FONT color="green">192</FONT> /**<a name="line.192"></a> |
| <FONT color="green">193</FONT> * Checks whether this Logger is enabled for the {@link Level#FATAL FATAL} Level.<a name="line.193"></a> |
| <FONT color="green">194</FONT> *<a name="line.194"></a> |
| <FONT color="green">195</FONT> * @param marker<a name="line.195"></a> |
| <FONT color="green">196</FONT> * The marker data specific to this log statement.<a name="line.196"></a> |
| <FONT color="green">197</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#FATAL FATAL}, {@code false}<a name="line.197"></a> |
| <FONT color="green">198</FONT> * otherwise.<a name="line.198"></a> |
| <FONT color="green">199</FONT> */<a name="line.199"></a> |
| <FONT color="green">200</FONT> boolean isFatalEnabled(Marker marker);<a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> /**<a name="line.202"></a> |
| <FONT color="green">203</FONT> * Checks whether this Logger is enabled for the {@link Level#INFO INFO} Level.<a name="line.203"></a> |
| <FONT color="green">204</FONT> *<a name="line.204"></a> |
| <FONT color="green">205</FONT> * @return boolean - {@code true} if this Logger is enabled for level INFO, {@code false} otherwise.<a name="line.205"></a> |
| <FONT color="green">206</FONT> */<a name="line.206"></a> |
| <FONT color="green">207</FONT> boolean isInfoEnabled();<a name="line.207"></a> |
| <FONT color="green">208</FONT> <a name="line.208"></a> |
| <FONT color="green">209</FONT> /**<a name="line.209"></a> |
| <FONT color="green">210</FONT> * Checks whether this Logger is enabled for the {@link Level#INFO INFO} Level.<a name="line.210"></a> |
| <FONT color="green">211</FONT> *<a name="line.211"></a> |
| <FONT color="green">212</FONT> * @param marker<a name="line.212"></a> |
| <FONT color="green">213</FONT> * The marker data specific to this log statement.<a name="line.213"></a> |
| <FONT color="green">214</FONT> * @return boolean - {@code true} if this Logger is enabled for level INFO, {@code false} otherwise.<a name="line.214"></a> |
| <FONT color="green">215</FONT> */<a name="line.215"></a> |
| <FONT color="green">216</FONT> boolean isInfoEnabled(Marker marker);<a name="line.216"></a> |
| <FONT color="green">217</FONT> <a name="line.217"></a> |
| <FONT color="green">218</FONT> /**<a name="line.218"></a> |
| <FONT color="green">219</FONT> * Checks whether this Logger is enabled for the {@link Level#TRACE TRACE} level.<a name="line.219"></a> |
| <FONT color="green">220</FONT> *<a name="line.220"></a> |
| <FONT color="green">221</FONT> * @return boolean - {@code true} if this Logger is enabled for level TRACE, {@code false} otherwise.<a name="line.221"></a> |
| <FONT color="green">222</FONT> */<a name="line.222"></a> |
| <FONT color="green">223</FONT> boolean isTraceEnabled();<a name="line.223"></a> |
| <FONT color="green">224</FONT> <a name="line.224"></a> |
| <FONT color="green">225</FONT> /**<a name="line.225"></a> |
| <FONT color="green">226</FONT> * Checks whether this Logger is enabled for the {@link Level#TRACE TRACE} level.<a name="line.226"></a> |
| <FONT color="green">227</FONT> *<a name="line.227"></a> |
| <FONT color="green">228</FONT> * @param marker<a name="line.228"></a> |
| <FONT color="green">229</FONT> * The marker data specific to this log statement.<a name="line.229"></a> |
| <FONT color="green">230</FONT> * @return boolean - {@code true} if this Logger is enabled for level TRACE, {@code false} otherwise.<a name="line.230"></a> |
| <FONT color="green">231</FONT> */<a name="line.231"></a> |
| <FONT color="green">232</FONT> boolean isTraceEnabled(Marker marker);<a name="line.232"></a> |
| <FONT color="green">233</FONT> <a name="line.233"></a> |
| <FONT color="green">234</FONT> /**<a name="line.234"></a> |
| <FONT color="green">235</FONT> * Checks whether this Logger is enabled for the {@link Level#WARN WARN} Level.<a name="line.235"></a> |
| <FONT color="green">236</FONT> *<a name="line.236"></a> |
| <FONT color="green">237</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#WARN WARN}, {@code false}<a name="line.237"></a> |
| <FONT color="green">238</FONT> * otherwise.<a name="line.238"></a> |
| <FONT color="green">239</FONT> */<a name="line.239"></a> |
| <FONT color="green">240</FONT> boolean isWarnEnabled();<a name="line.240"></a> |
| <FONT color="green">241</FONT> <a name="line.241"></a> |
| <FONT color="green">242</FONT> /**<a name="line.242"></a> |
| <FONT color="green">243</FONT> * Checks whether this Logger is enabled for the {@link Level#WARN WARN} Level.<a name="line.243"></a> |
| <FONT color="green">244</FONT> *<a name="line.244"></a> |
| <FONT color="green">245</FONT> * @param marker<a name="line.245"></a> |
| <FONT color="green">246</FONT> * The marker data specific to this log statement.<a name="line.246"></a> |
| <FONT color="green">247</FONT> * @return boolean - {@code true} if this Logger is enabled for level {@link Level#WARN WARN}, {@code false}<a name="line.247"></a> |
| <FONT color="green">248</FONT> * otherwise.<a name="line.248"></a> |
| <FONT color="green">249</FONT> */<a name="line.249"></a> |
| <FONT color="green">250</FONT> boolean isWarnEnabled(Marker marker);<a name="line.250"></a> |
| <FONT color="green">251</FONT> <a name="line.251"></a> |
| <FONT color="green">252</FONT> /**<a name="line.252"></a> |
| <FONT color="green">253</FONT> * Logs a message with the specific Marker at the given level.<a name="line.253"></a> |
| <FONT color="green">254</FONT> *<a name="line.254"></a> |
| <FONT color="green">255</FONT> * <a name="line.255"></a> |
| <FONT color="green">256</FONT> * @param marker<a name="line.256"></a> |
| <FONT color="green">257</FONT> * the marker data specific to this log statement<a name="line.257"></a> |
| <FONT color="green">258</FONT> * @param msg<a name="line.258"></a> |
| <FONT color="green">259</FONT> * the message string to be logged<a name="line.259"></a> |
| <FONT color="green">260</FONT> */<a name="line.260"></a> |
| <FONT color="green">261</FONT> void log(Marker marker, Message msg);<a name="line.261"></a> |
| <FONT color="green">262</FONT> <a name="line.262"></a> |
| <FONT color="green">263</FONT> /**<a name="line.263"></a> |
| <FONT color="green">264</FONT> * Logs a message with the specific Marker at the given level.<a name="line.264"></a> |
| <FONT color="green">265</FONT> *<a name="line.265"></a> |
| <FONT color="green">266</FONT> * @param marker<a name="line.266"></a> |
| <FONT color="green">267</FONT> * the marker data specific to this log statement<a name="line.267"></a> |
| <FONT color="green">268</FONT> * @param msg<a name="line.268"></a> |
| <FONT color="green">269</FONT> * the message string to be logged<a name="line.269"></a> |
| <FONT color="green">270</FONT> * @param t<a name="line.270"></a> |
| <FONT color="green">271</FONT> * A Throwable or null.<a name="line.271"></a> |
| <FONT color="green">272</FONT> */<a name="line.272"></a> |
| <FONT color="green">273</FONT> void log(Marker marker, Message msg, Throwable t);<a name="line.273"></a> |
| <FONT color="green">274</FONT> <a name="line.274"></a> |
| <FONT color="green">275</FONT> /**<a name="line.275"></a> |
| <FONT color="green">276</FONT> * Logs a message object with the given level.<a name="line.276"></a> |
| <FONT color="green">277</FONT> *<a name="line.277"></a> |
| <FONT color="green">278</FONT> * @param marker<a name="line.278"></a> |
| <FONT color="green">279</FONT> * the marker data specific to this log statement<a name="line.279"></a> |
| <FONT color="green">280</FONT> * @param message<a name="line.280"></a> |
| <FONT color="green">281</FONT> * the message object to log.<a name="line.281"></a> |
| <FONT color="green">282</FONT> */<a name="line.282"></a> |
| <FONT color="green">283</FONT> void log(Marker marker, Object message);<a name="line.283"></a> |
| <FONT color="green">284</FONT> <a name="line.284"></a> |
| <FONT color="green">285</FONT> /**<a name="line.285"></a> |
| <FONT color="green">286</FONT> * Logs a message at the given level including the stack trace of the {@link Throwable} <code>t</code> passed as<a name="line.286"></a> |
| <FONT color="green">287</FONT> * parameter.<a name="line.287"></a> |
| <FONT color="green">288</FONT> *<a name="line.288"></a> |
| <FONT color="green">289</FONT> * @param marker<a name="line.289"></a> |
| <FONT color="green">290</FONT> * the marker data specific to this log statement<a name="line.290"></a> |
| <FONT color="green">291</FONT> * @param message<a name="line.291"></a> |
| <FONT color="green">292</FONT> * the message to log.<a name="line.292"></a> |
| <FONT color="green">293</FONT> * @param t<a name="line.293"></a> |
| <FONT color="green">294</FONT> * the exception to log, including its stack trace.<a name="line.294"></a> |
| <FONT color="green">295</FONT> */<a name="line.295"></a> |
| <FONT color="green">296</FONT> void log(Marker marker, Object message, Throwable t);<a name="line.296"></a> |
| <FONT color="green">297</FONT> <a name="line.297"></a> |
| <FONT color="green">298</FONT> /**<a name="line.298"></a> |
| <FONT color="green">299</FONT> * Logs a message object with the given level.<a name="line.299"></a> |
| <FONT color="green">300</FONT> *<a name="line.300"></a> |
| <FONT color="green">301</FONT> * <a name="line.301"></a> |
| <FONT color="green">302</FONT> * @param marker<a name="line.302"></a> |
| <FONT color="green">303</FONT> * the marker data specific to this log statement<a name="line.303"></a> |
| <FONT color="green">304</FONT> * @param message<a name="line.304"></a> |
| <FONT color="green">305</FONT> * the message object to log.<a name="line.305"></a> |
| <FONT color="green">306</FONT> */<a name="line.306"></a> |
| <FONT color="green">307</FONT> void log(Marker marker, String message);<a name="line.307"></a> |
| <FONT color="green">308</FONT> <a name="line.308"></a> |
| <FONT color="green">309</FONT> /**<a name="line.309"></a> |
| <FONT color="green">310</FONT> * Logs a message with parameters at the given level.<a name="line.310"></a> |
| <FONT color="green">311</FONT> *<a name="line.311"></a> |
| <FONT color="green">312</FONT> * @param marker<a name="line.312"></a> |
| <FONT color="green">313</FONT> * the marker data specific to this log statement<a name="line.313"></a> |
| <FONT color="green">314</FONT> * @param message<a name="line.314"></a> |
| <FONT color="green">315</FONT> * the message to log; the format depends on the message factory.<a name="line.315"></a> |
| <FONT color="green">316</FONT> * @param params<a name="line.316"></a> |
| <FONT color="green">317</FONT> * parameters to the message.<a name="line.317"></a> |
| <FONT color="green">318</FONT> * @see #getMessageFactory()<a name="line.318"></a> |
| <FONT color="green">319</FONT> */<a name="line.319"></a> |
| <FONT color="green">320</FONT> void log(Marker marker, String message, Object... params);<a name="line.320"></a> |
| <FONT color="green">321</FONT> <a name="line.321"></a> |
| <FONT color="green">322</FONT> /**<a name="line.322"></a> |
| <FONT color="green">323</FONT> * Logs a message at the given level including the stack trace of the {@link Throwable} <code>t</code> passed as<a name="line.323"></a> |
| <FONT color="green">324</FONT> * parameter.<a name="line.324"></a> |
| <FONT color="green">325</FONT> *<a name="line.325"></a> |
| <FONT color="green">326</FONT> * @param marker<a name="line.326"></a> |
| <FONT color="green">327</FONT> * the marker data specific to this log statement<a name="line.327"></a> |
| <FONT color="green">328</FONT> * @param message<a name="line.328"></a> |
| <FONT color="green">329</FONT> * the message to log.<a name="line.329"></a> |
| <FONT color="green">330</FONT> * @param t<a name="line.330"></a> |
| <FONT color="green">331</FONT> * the exception to log, including its stack trace.<a name="line.331"></a> |
| <FONT color="green">332</FONT> */<a name="line.332"></a> |
| <FONT color="green">333</FONT> void log(Marker marker, String message, Throwable t);<a name="line.333"></a> |
| <FONT color="green">334</FONT> <a name="line.334"></a> |
| <FONT color="green">335</FONT> /**<a name="line.335"></a> |
| <FONT color="green">336</FONT> * Logs a message with the specific Marker at the given level.<a name="line.336"></a> |
| <FONT color="green">337</FONT> *<a name="line.337"></a> |
| <FONT color="green">338</FONT> * @param msg<a name="line.338"></a> |
| <FONT color="green">339</FONT> * the message string to be logged<a name="line.339"></a> |
| <FONT color="green">340</FONT> */<a name="line.340"></a> |
| <FONT color="green">341</FONT> void log(Message msg);<a name="line.341"></a> |
| <FONT color="green">342</FONT> <a name="line.342"></a> |
| <FONT color="green">343</FONT> /**<a name="line.343"></a> |
| <FONT color="green">344</FONT> * Logs a message with the specific Marker at the given level.<a name="line.344"></a> |
| <FONT color="green">345</FONT> *<a name="line.345"></a> |
| <FONT color="green">346</FONT> * @param msg<a name="line.346"></a> |
| <FONT color="green">347</FONT> * the message string to be logged<a name="line.347"></a> |
| <FONT color="green">348</FONT> * @param t<a name="line.348"></a> |
| <FONT color="green">349</FONT> * A Throwable or null.<a name="line.349"></a> |
| <FONT color="green">350</FONT> */<a name="line.350"></a> |
| <FONT color="green">351</FONT> void log(Message msg, Throwable t);<a name="line.351"></a> |
| <FONT color="green">352</FONT> <a name="line.352"></a> |
| <FONT color="green">353</FONT> /**<a name="line.353"></a> |
| <FONT color="green">354</FONT> * Logs a message object with the given level.<a name="line.354"></a> |
| <FONT color="green">355</FONT> *<a name="line.355"></a> |
| <FONT color="green">356</FONT> * @param message<a name="line.356"></a> |
| <FONT color="green">357</FONT> * the message object to log.<a name="line.357"></a> |
| <FONT color="green">358</FONT> */<a name="line.358"></a> |
| <FONT color="green">359</FONT> void log(Object message);<a name="line.359"></a> |
| <FONT color="green">360</FONT> <a name="line.360"></a> |
| <FONT color="green">361</FONT> /**<a name="line.361"></a> |
| <FONT color="green">362</FONT> * Logs a message at the given level including the stack trace of the {@link Throwable} <code>t</code> passed as<a name="line.362"></a> |
| <FONT color="green">363</FONT> * parameter.<a name="line.363"></a> |
| <FONT color="green">364</FONT> *<a name="line.364"></a> |
| <FONT color="green">365</FONT> * @param message<a name="line.365"></a> |
| <FONT color="green">366</FONT> * the message to log.<a name="line.366"></a> |
| <FONT color="green">367</FONT> * @param t<a name="line.367"></a> |
| <FONT color="green">368</FONT> * the exception to log, including its stack trace.<a name="line.368"></a> |
| <FONT color="green">369</FONT> */<a name="line.369"></a> |
| <FONT color="green">370</FONT> void log(Object message, Throwable t);<a name="line.370"></a> |
| <FONT color="green">371</FONT> <a name="line.371"></a> |
| <FONT color="green">372</FONT> /**<a name="line.372"></a> |
| <FONT color="green">373</FONT> * Logs a message object with the given level.<a name="line.373"></a> |
| <FONT color="green">374</FONT> *<a name="line.374"></a> |
| <FONT color="green">375</FONT> * @param message<a name="line.375"></a> |
| <FONT color="green">376</FONT> * the message string to log.<a name="line.376"></a> |
| <FONT color="green">377</FONT> */<a name="line.377"></a> |
| <FONT color="green">378</FONT> void log(String message);<a name="line.378"></a> |
| <FONT color="green">379</FONT> <a name="line.379"></a> |
| <FONT color="green">380</FONT> /**<a name="line.380"></a> |
| <FONT color="green">381</FONT> * Logs a message with parameters at the given level.<a name="line.381"></a> |
| <FONT color="green">382</FONT> *<a name="line.382"></a> |
| <FONT color="green">383</FONT> * <a name="line.383"></a> |
| <FONT color="green">384</FONT> * @param message<a name="line.384"></a> |
| <FONT color="green">385</FONT> * the message to log; the format depends on the message factory.<a name="line.385"></a> |
| <FONT color="green">386</FONT> * @param params<a name="line.386"></a> |
| <FONT color="green">387</FONT> * parameters to the message.<a name="line.387"></a> |
| <FONT color="green">388</FONT> * @see #getMessageFactory()<a name="line.388"></a> |
| <FONT color="green">389</FONT> */<a name="line.389"></a> |
| <FONT color="green">390</FONT> void log(String message, Object... params);<a name="line.390"></a> |
| <FONT color="green">391</FONT> <a name="line.391"></a> |
| <FONT color="green">392</FONT> /**<a name="line.392"></a> |
| <FONT color="green">393</FONT> * Logs a message at the given level including the stack trace of the {@link Throwable} <code>t</code> passed as<a name="line.393"></a> |
| <FONT color="green">394</FONT> * parameter.<a name="line.394"></a> |
| <FONT color="green">395</FONT> *<a name="line.395"></a> |
| <FONT color="green">396</FONT> * <a name="line.396"></a> |
| <FONT color="green">397</FONT> * @param message<a name="line.397"></a> |
| <FONT color="green">398</FONT> * the message to log.<a name="line.398"></a> |
| <FONT color="green">399</FONT> * @param t<a name="line.399"></a> |
| <FONT color="green">400</FONT> * the exception to log, including its stack trace.<a name="line.400"></a> |
| <FONT color="green">401</FONT> */<a name="line.401"></a> |
| <FONT color="green">402</FONT> void log(String message, Throwable t);<a name="line.402"></a> |
| <FONT color="green">403</FONT> <a name="line.403"></a> |
| <FONT color="green">404</FONT> /**<a name="line.404"></a> |
| <FONT color="green">405</FONT> * Logs a formatted message using the specified format string and arguments.<a name="line.405"></a> |
| <FONT color="green">406</FONT> *<a name="line.406"></a> |
| <FONT color="green">407</FONT> * <a name="line.407"></a> |
| <FONT color="green">408</FONT> * @param marker<a name="line.408"></a> |
| <FONT color="green">409</FONT> * the marker data specific to this log statement.<a name="line.409"></a> |
| <FONT color="green">410</FONT> * @param format<a name="line.410"></a> |
| <FONT color="green">411</FONT> * The format String.<a name="line.411"></a> |
| <FONT color="green">412</FONT> * @param params<a name="line.412"></a> |
| <FONT color="green">413</FONT> * Arguments specified by the format.<a name="line.413"></a> |
| <FONT color="green">414</FONT> */<a name="line.414"></a> |
| <FONT color="green">415</FONT> void printf(Marker marker, String format, Object... params);<a name="line.415"></a> |
| <FONT color="green">416</FONT> <a name="line.416"></a> |
| <FONT color="green">417</FONT> /**<a name="line.417"></a> |
| <FONT color="green">418</FONT> * Logs a formatted message using the specified format string and arguments.<a name="line.418"></a> |
| <FONT color="green">419</FONT> *<a name="line.419"></a> |
| <FONT color="green">420</FONT> * <a name="line.420"></a> |
| <FONT color="green">421</FONT> * @param format<a name="line.421"></a> |
| <FONT color="green">422</FONT> * The format String.<a name="line.422"></a> |
| <FONT color="green">423</FONT> * @param params<a name="line.423"></a> |
| <FONT color="green">424</FONT> * Arguments specified by the format.<a name="line.424"></a> |
| <FONT color="green">425</FONT> */<a name="line.425"></a> |
| <FONT color="green">426</FONT> void printf(String format, Object... params);<a name="line.426"></a> |
| <FONT color="green">427</FONT> <a name="line.427"></a> |
| <FONT color="green">428</FONT> /**<a name="line.428"></a> |
| <FONT color="green">429</FONT> * Logs an exception or error to be thrown. This may be coded as:<a name="line.429"></a> |
| <FONT color="green">430</FONT> * <a name="line.430"></a> |
| <FONT color="green">431</FONT> * <pre><a name="line.431"></a> |
| <FONT color="green">432</FONT> * throw logger.throwing(myException);<a name="line.432"></a> |
| <FONT color="green">433</FONT> * </pre><a name="line.433"></a> |
| <FONT color="green">434</FONT> *<a name="line.434"></a> |
| <FONT color="green">435</FONT> * @param <T><a name="line.435"></a> |
| <FONT color="green">436</FONT> * the Throwable type.<a name="line.436"></a> |
| <FONT color="green">437</FONT> * @param t<a name="line.437"></a> |
| <FONT color="green">438</FONT> * The Throwable.<a name="line.438"></a> |
| <FONT color="green">439</FONT> * @return the Throwable.<a name="line.439"></a> |
| <FONT color="green">440</FONT> */<a name="line.440"></a> |
| <FONT color="green">441</FONT> <T extends Throwable> T throwing(T t);<a name="line.441"></a> |
| <FONT color="green">442</FONT> }<a name="line.442"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
