Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-1.2-api / apidocs / src-html / org / apache / log4j / spi / LoggingEvent.html
blob: e6efc59c0ac02397e2b9233ab1d158cc88720ee1 [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.spi;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.log4j.Category;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.log4j.Level;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.log4j.bridge.LogEventAdapter;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Set;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * No-op version of Log4j 1.2 LoggingEvent. This class is not directly used by Log4j 1.x clients but is used by<a name="line.27"></a>
<span class="sourceLineNo">028</span> * the Log4j 2 LogEvent adapter to be compatible with Log4j 1.x components.<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>public class LoggingEvent {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> /**<a name="line.32"></a>
<span class="sourceLineNo">033</span> Set the location information for this logging event. The collected<a name="line.33"></a>
<span class="sourceLineNo">034</span> information is cached for future use.<a name="line.34"></a>
<span class="sourceLineNo">035</span> @return Always returns null.<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span> public LocationInfo getLocationInformation() {<a name="line.37"></a>
<span class="sourceLineNo">038</span> return null;<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> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Return the level of this event. Use this form instead of directly<a name="line.42"></a>
<span class="sourceLineNo">043</span> * accessing the &lt;code&gt;level&lt;/code&gt; field.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @return Always returns null.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> public Level getLevel() {<a name="line.46"></a>
<span class="sourceLineNo">047</span> return null;<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * Return the name of the logger. Use this form instead of directly<a name="line.51"></a>
<span class="sourceLineNo">052</span> * accessing the &lt;code&gt;categoryName&lt;/code&gt; field.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @return Always returns null.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public String getLoggerName() {<a name="line.55"></a>
<span class="sourceLineNo">056</span> return null;<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> public String getFQNOfLoggerClass() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> return null;<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> public final long getTimeStamp() {<a name="line.63"></a>
<span class="sourceLineNo">064</span> return 0;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Gets the logger of the event.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * Use should be restricted to cloning events.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @return Always returns null.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @since 1.2.15<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> public Category getLogger() {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return null;<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<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> Return the message for this logging event.<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> &lt;p&gt;Before serialization, the returned object is the message<a name="line.80"></a>
<span class="sourceLineNo">081</span> passed by the user to generate the logging event. After<a name="line.81"></a>
<span class="sourceLineNo">082</span> serialization, the returned value equals the String form of the<a name="line.82"></a>
<span class="sourceLineNo">083</span> message possibly after object rendering.<a name="line.83"></a>
<span class="sourceLineNo">084</span> @return Always returns null.<a name="line.84"></a>
<span class="sourceLineNo">085</span> @since 1.1 */<a name="line.85"></a>
<span class="sourceLineNo">086</span> public<a name="line.86"></a>
<span class="sourceLineNo">087</span> Object getMessage() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return null;<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> public<a name="line.91"></a>
<span class="sourceLineNo">092</span> String getNDC() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return null;<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> public<a name="line.96"></a>
<span class="sourceLineNo">097</span> Object getMDC(String key) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return null;<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> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> Obtain a copy of this thread's MDC prior to serialization or<a name="line.102"></a>
<span class="sourceLineNo">103</span> asynchronous logging.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> public void getMDCCopy() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> public String getRenderedMessage() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> return null;<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> Returns the time when the application started, in milliseconds<a name="line.113"></a>
<span class="sourceLineNo">114</span> elapsed since 01.01.1970.<a name="line.114"></a>
<span class="sourceLineNo">115</span> @return the JVM start time.<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> public static long getStartTime() {<a name="line.117"></a>
<span class="sourceLineNo">118</span> return LogEventAdapter.getStartTime();<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> public String getThreadName() {<a name="line.121"></a>
<span class="sourceLineNo">122</span> return null;<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> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> Returns the throwable information contained within this<a name="line.126"></a>
<span class="sourceLineNo">127</span> event. May be &lt;code&gt;null&lt;/code&gt; if there is no such information.<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> &lt;p&gt;Note that the {@link Throwable} object contained within a<a name="line.129"></a>
<span class="sourceLineNo">130</span> {@link ThrowableInformation} does not survive serialization.<a name="line.130"></a>
<span class="sourceLineNo">131</span> @return Always returns null.<a name="line.131"></a>
<span class="sourceLineNo">132</span> @since 1.1 */<a name="line.132"></a>
<span class="sourceLineNo">133</span> public ThrowableInformation getThrowableInformation() {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return null;<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> /**<a name="line.137"></a>
<span class="sourceLineNo">138</span> Return this event's throwable's string[] representaion.<a name="line.138"></a>
<span class="sourceLineNo">139</span> @return Always returns null.<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public String[] getThrowableStrRep() {<a name="line.141"></a>
<span class="sourceLineNo">142</span> return null;<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> public void setProperty(final String propName,<a name="line.145"></a>
<span class="sourceLineNo">146</span> final String propValue) {<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> public String getProperty(final String key) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return null;<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> public Set getPropertyKeySet() {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return null;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> public Map getProperties() {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return null;<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> public Object removeProperty(String propName) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return null;<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>
</pre>
</div>
</body>
</html>