blob: f7d1ac1651bfc6ad309852ab23d6a97bd9057384 [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> /**<a name="line.19"></a>
<FONT color="green">020</FONT> * A Message that can render itself in more than one way. The format string is used by the<a name="line.20"></a>
<FONT color="green">021</FONT> * Message implementation as extra information that it may use to help it to determine how<a name="line.21"></a>
<FONT color="green">022</FONT> * to format itself. For example, MapMessage accepts a format of "XML" to tell it to render<a name="line.22"></a>
<FONT color="green">023</FONT> * the Map as XML instead of its default format of {key1="value1" key2="value2"}.<a name="line.23"></a>
<FONT color="green">024</FONT> */<a name="line.24"></a>
<FONT color="green">025</FONT> public interface MultiformatMessage extends Message {<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Returns the Message formatted as a String.<a name="line.28"></a>
<FONT color="green">029</FONT> *<a name="line.29"></a>
<FONT color="green">030</FONT> * @param formats An array of Strings that provide extra information about how to format the message.<a name="line.30"></a>
<FONT color="green">031</FONT> * Each MultiformatMessage implementation is free to use the provided formats however they choose.<a name="line.31"></a>
<FONT color="green">032</FONT> *<a name="line.32"></a>
<FONT color="green">033</FONT> * @return The message String.<a name="line.33"></a>
<FONT color="green">034</FONT> */<a name="line.34"></a>
<FONT color="green">035</FONT> String getFormattedMessage(String[] formats);<a name="line.35"></a>
<FONT color="green">036</FONT> }<a name="line.36"></a>
</PRE>
</BODY>
</HTML>