| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>Message xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/logging/log4j/message/Message.html">View Javadoc</a></div><pre> |
| |
| <a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em> |
| <a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.message; |
| <a class="jxr_linenumber" name="18" href="#18">18</a> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a class="jxr_linenumber" name="20" href="#20">20</a> |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * An interface for various Message implementations that can be logged. Messages can act as wrappers</em> |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * around Objects so that user can have control over converting Objects to Strings when necessary without</em> |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * requiring complicated formatters and as a way to manipulate the message based on information available</em> |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * at runtime such as the locale of the system.</em> |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> *<p></em> |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * Note: Message objects should not be considered to be thread safe nor should they be assumed to be</em> |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * safely reusable even on the same thread. The logging system may provide information to the Message</em> |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * objects and the Messages might be queued for asynchronous delivery. Thus, any modifications to a</em> |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Message object by an application should by avoided after the Message has been passed as a parameter on</em> |
| <a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * a Logger method.</em> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @doubt Interfaces should rarely extend Serializable according to Effective Java 2nd Ed pg 291.</em> |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * (RG) That section also says "If a class or interface exists primarily to participate in a framework that</em> |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * requires all participants to implement Serializable, then it makes perfect sense for the class or</em> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * interface to implement or extend Serializable". Such is the case here as the LogEvent must be Serializable.</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/logging/log4j/message/Message.html">Message</a> <strong class="jxr_keyword">extends</strong> Serializable { |
| <a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Returns the Message formatted as a String. Each Message implementation determines the</em> |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * appropriate way to format the data encapsulated in the Message. Messages that provide</em> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * more than one way of formatting the Message will implement MultiformatMessage.</em> |
| <a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @return The message String.</em> |
| <a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="46" href="#46">46</a> String getFormattedMessage(); |
| <a class="jxr_linenumber" name="47" href="#47">47</a> |
| <a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Returns the format portion of the Message.</em> |
| <a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return The message format. Some implementations, such as ParameterizedMessage, will use this as</em> |
| <a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * the message "pattern". Other Messages may simply return an empty String.</em> |
| <a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @doubt Do all messages have a format? What syntax? Using a Formatter object could be cleaner.</em> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and</em> |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * StructuredDataMessage it is not. It is up to the Message implementer to determine what this</em> |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * method will return. A Formatter is inappropriate as this is very specific to the Message</em> |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.</em> |
| <a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="59" href="#59">59</a> String getMessageFormat(); |
| <a class="jxr_linenumber" name="60" href="#60">60</a> |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Returns parameter values, if any.</em> |
| <a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @return An array of parameter values or null.</em> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="66" href="#66">66</a> Object[] getParameters(); |
| <a class="jxr_linenumber" name="67" href="#67">67</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
