| <!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.StringBuilderFormattable;<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> * Messages implementing this interface are reused between logging calls.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <p><a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * If a Message is reusable, downstream components should not hand over this instance to another thread, but extract its<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * content (via the {@link StringBuilderFormattable#formatTo(StringBuilder)} method) instead.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * </p><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @see ReusableMessageFactory<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * @since 2.6<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>@PerformanceSensitive("allocation")<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>public interface ReusableMessage extends Message, StringBuilderFormattable {<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> /**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Returns the parameter array that was used to initialize this reusable message and replaces it with the specified<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * array. The returned parameter array will no longer be modified by this reusable message. The specified array is<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * now "owned" by this reusable message and can be modified if necessary for the next log event.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * </p><p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * ReusableMessages that have no parameters return the specified array.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * This method is used by asynchronous loggers to pass the parameter array to a background thread without<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * allocating new objects.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * The actual number of parameters in the returned array can be determined with {@link #getParameterCount()}.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * </p><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param emptyReplacement the parameter array that can be used for subsequent uses of this reusable message.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * This replacement array must have at least 10 elements (the number of varargs supported by the Logger<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * API).<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @return the parameter array for the current message content. This may be a vararg array of any length, or it may<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * be a reusable array of 10 elements used to hold the unrolled vararg parameters.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @see #getParameterCount()<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> Object[] swapParameters(Object[] emptyReplacement);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Returns the number of parameters that was used to initialize this reusable message for the current content.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <p><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * The parameter array returned by {@link #swapParameters(Object[])} may be larger than the actual number of<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * parameters. Callers should use this method to determine how many elements the array contains.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * </p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @return the current number of parameters<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> short getParameterCount();<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Returns an immutable snapshot of the current internal state of this reusable message. The returned snapshot<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * will not be affected by subsequent modifications of this reusable message.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @return an immutable snapshot of this message<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> Message memento();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span>}<a name="line.72"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
