Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1 / log4j-api / apidocs / src-html / org / apache / logging / log4j / message / ObjectMessage.html
blob: 1a77f6001dee9721f4486e995c67125afc25fb32 [file] [log] [blame]
<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.message;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import java.io.IOException;<a name="line.19"></a>
<FONT color="green">020</FONT> import java.io.ObjectInputStream;<a name="line.20"></a>
<FONT color="green">021</FONT> import java.io.ObjectOutputStream;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.io.Serializable;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> /**<a name="line.24"></a>
<FONT color="green">025</FONT> * Handles messages that contain an Object.<a name="line.25"></a>
<FONT color="green">026</FONT> */<a name="line.26"></a>
<FONT color="green">027</FONT> public class ObjectMessage implements Message, Serializable {<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> private static final long serialVersionUID = -5903272448334166185L;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> private transient Object obj;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * Create the ObjectMessage.<a name="line.34"></a>
<FONT color="green">035</FONT> * @param obj The Object to format.<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> public ObjectMessage(Object obj) {<a name="line.37"></a>
<FONT color="green">038</FONT> if (obj == null) {<a name="line.38"></a>
<FONT color="green">039</FONT> obj = "null";<a name="line.39"></a>
<FONT color="green">040</FONT> }<a name="line.40"></a>
<FONT color="green">041</FONT> this.obj = obj;<a name="line.41"></a>
<FONT color="green">042</FONT> }<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Return the formatted object message.<a name="line.45"></a>
<FONT color="green">046</FONT> * @return the formatted object message.<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> public String getFormattedMessage() {<a name="line.48"></a>
<FONT color="green">049</FONT> return obj.toString();<a name="line.49"></a>
<FONT color="green">050</FONT> }<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * Returns the object formatted using its toString method.<a name="line.53"></a>
<FONT color="green">054</FONT> * @return the String representation of the object.<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> public String getMessageFormat() {<a name="line.56"></a>
<FONT color="green">057</FONT> return obj.toString();<a name="line.57"></a>
<FONT color="green">058</FONT> }<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> * Returns the object as if it were a parameter.<a name="line.61"></a>
<FONT color="green">062</FONT> * @return The object.<a name="line.62"></a>
<FONT color="green">063</FONT> */<a name="line.63"></a>
<FONT color="green">064</FONT> public Object[] getParameters() {<a name="line.64"></a>
<FONT color="green">065</FONT> return new Object[]{obj};<a name="line.65"></a>
<FONT color="green">066</FONT> }<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> public boolean equals(Object o) {<a name="line.68"></a>
<FONT color="green">069</FONT> if (this == o) {<a name="line.69"></a>
<FONT color="green">070</FONT> return true;<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> if (o == null || getClass() != o.getClass()) {<a name="line.72"></a>
<FONT color="green">073</FONT> return false;<a name="line.73"></a>
<FONT color="green">074</FONT> }<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> ObjectMessage that = (ObjectMessage) o;<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> return !(obj != null ? !obj.equals(that.obj) : that.obj != null);<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> public int hashCode() {<a name="line.81"></a>
<FONT color="green">082</FONT> return obj != null ? obj.hashCode() : 0;<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> public String toString() {<a name="line.85"></a>
<FONT color="green">086</FONT> return "ObjectMessage[obj=" + obj.toString() + "]";<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> private void writeObject(ObjectOutputStream out) throws IOException {<a name="line.89"></a>
<FONT color="green">090</FONT> out.defaultWriteObject();<a name="line.90"></a>
<FONT color="green">091</FONT> if (obj instanceof Serializable) {<a name="line.91"></a>
<FONT color="green">092</FONT> out.writeObject(obj);<a name="line.92"></a>
<FONT color="green">093</FONT> } else {<a name="line.93"></a>
<FONT color="green">094</FONT> out.writeObject(obj.toString());<a name="line.94"></a>
<FONT color="green">095</FONT> }<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {<a name="line.98"></a>
<FONT color="green">099</FONT> in.defaultReadObject();<a name="line.99"></a>
<FONT color="green">100</FONT> obj = in.readObject();<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> }<a name="line.102"></a>
</PRE>
</BODY>
</HTML>