Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-api / apidocs / src-html / org / apache / logging / log4j / message / ReusableObjectMessage.html
blob: 3dbada949f756bb504601a2712081ac6d572ec9c [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.logging.log4j.message;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.logging.log4j.util.PerformanceSensitive;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.logging.log4j.util.StringBuilders;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * Mutable Message wrapper around an Object message.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * @since 2.6<a name="line.24"></a>
<span class="sourceLineNo">025</span> */<a name="line.25"></a>
<span class="sourceLineNo">026</span>@PerformanceSensitive("allocation")<a name="line.26"></a>
<span class="sourceLineNo">027</span>public class ReusableObjectMessage implements ReusableMessage, ParameterVisitable, Clearable {<a name="line.27"></a>
<span class="sourceLineNo">028</span> private static final long serialVersionUID = 6922476812535519960L;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span> private transient Object obj;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> public void set(final Object object) {<a name="line.32"></a>
<span class="sourceLineNo">033</span> this.obj = object;<a name="line.33"></a>
<span class="sourceLineNo">034</span> }<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Returns the formatted object message.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @return the formatted object message.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> @Override<a name="line.41"></a>
<span class="sourceLineNo">042</span> public String getFormattedMessage() {<a name="line.42"></a>
<span class="sourceLineNo">043</span> return String.valueOf(obj);<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> @Override<a name="line.46"></a>
<span class="sourceLineNo">047</span> public void formatTo(final StringBuilder buffer) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> StringBuilders.appendValue(buffer, obj);<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> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Returns the object formatted using its toString method.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @return the String representation of the object.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span> public String getFormat() {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return obj instanceof String ? (String) obj : null;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Returns the object parameter.<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @return The object.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @since 2.7<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public Object getParameter() {<a name="line.67"></a>
<span class="sourceLineNo">068</span> return obj;<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> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Returns the object as if it were a parameter.<a name="line.72"></a>
<span class="sourceLineNo">073</span> *<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @return The object.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public Object[] getParameters() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return new Object[] {obj};<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public String toString() {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return getFormattedMessage();<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * Gets the message if it is a throwable.<a name="line.87"></a>
<span class="sourceLineNo">088</span> *<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @return the message if it is a throwable.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> public Throwable getThrowable() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return obj instanceof Throwable ? (Throwable) obj : 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> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * This message has exactly one parameter (the object), so returns it as the first parameter in the array.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param emptyReplacement the parameter array to return<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @return the specified array<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> @Override<a name="line.101"></a>
<span class="sourceLineNo">102</span> public Object[] swapParameters(final Object[] emptyReplacement) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> // it's unlikely that emptyReplacement is of length 0, but if it is,<a name="line.103"></a>
<span class="sourceLineNo">104</span> // go ahead and allocate the memory now;<a name="line.104"></a>
<span class="sourceLineNo">105</span> // this saves an allocation in the future when this buffer is re-used<a name="line.105"></a>
<span class="sourceLineNo">106</span> if (emptyReplacement.length == 0) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> final Object[] params = new Object[10]; // Default reusable parameter buffer size<a name="line.107"></a>
<span class="sourceLineNo">108</span> params[0] = obj;<a name="line.108"></a>
<span class="sourceLineNo">109</span> return params;<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> emptyReplacement[0] = obj;<a name="line.111"></a>
<span class="sourceLineNo">112</span> return emptyReplacement;<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * This message has exactly one parameter (the object), so always returns one.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @return 1<a name="line.117"></a>
<span class="sourceLineNo">118</span> */<a name="line.118"></a>
<span class="sourceLineNo">119</span> @Override<a name="line.119"></a>
<span class="sourceLineNo">120</span> public short getParameterCount() {<a name="line.120"></a>
<span class="sourceLineNo">121</span> return 1;<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> @Override<a name="line.124"></a>
<span class="sourceLineNo">125</span> public &lt;S&gt; void forEachParameter(final ParameterConsumer&lt;S&gt; action, final S state) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> action.accept(obj, 0, state);<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span> public Message memento() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return new ObjectMessage(obj);<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span> public void clear() {<a name="line.135"></a>
<span class="sourceLineNo">136</span> obj = null;<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span>}<a name="line.138"></a>
</pre>
</div>
</body>
</html>