| <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.log4j;<a name="line.17"></a> |
| <FONT color="green">018</FONT> <a name="line.18"></a> |
| <FONT color="green">019</FONT> import org.apache.log4j.spi.LoggingEvent;<a name="line.19"></a> |
| <FONT color="green">020</FONT> import org.apache.logging.log4j.core.util.Constants;<a name="line.20"></a> |
| <FONT color="green">021</FONT> <a name="line.21"></a> |
| <FONT color="green">022</FONT> /**<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> public abstract class Layout {<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> /** Note that the line.separator property can be looked up even by applets. */<a name="line.27"></a> |
| <FONT color="green">028</FONT> public static final int LINE_SEP_LEN = Constants.LINE_SEPARATOR.length();<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> /**<a name="line.30"></a> |
| <FONT color="green">031</FONT> * Implement this method to create your own layout format.<a name="line.31"></a> |
| <FONT color="green">032</FONT> * @param event The LoggingEvent.<a name="line.32"></a> |
| <FONT color="green">033</FONT> * @return The formatted LoggingEvent.<a name="line.33"></a> |
| <FONT color="green">034</FONT> */<a name="line.34"></a> |
| <FONT color="green">035</FONT> public abstract String format(LoggingEvent event);<a name="line.35"></a> |
| <FONT color="green">036</FONT> <a name="line.36"></a> |
| <FONT color="green">037</FONT> /**<a name="line.37"></a> |
| <FONT color="green">038</FONT> * Returns the content type output by this layout. The base class<a name="line.38"></a> |
| <FONT color="green">039</FONT> * returns "text/plain".<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @return the type of content rendered by the Layout.<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public String getContentType() {<a name="line.42"></a> |
| <FONT color="green">043</FONT> return "text/plain";<a name="line.43"></a> |
| <FONT color="green">044</FONT> }<a name="line.44"></a> |
| <FONT color="green">045</FONT> <a name="line.45"></a> |
| <FONT color="green">046</FONT> /**<a name="line.46"></a> |
| <FONT color="green">047</FONT> * Returns the header for the layout format. The base class returns<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <code>null</code>.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @return The header.<a name="line.49"></a> |
| <FONT color="green">050</FONT> */<a name="line.50"></a> |
| <FONT color="green">051</FONT> public String getHeader() {<a name="line.51"></a> |
| <FONT color="green">052</FONT> return null;<a name="line.52"></a> |
| <FONT color="green">053</FONT> }<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> /**<a name="line.55"></a> |
| <FONT color="green">056</FONT> * Returns the footer for the layout format. The base class returns<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <code>null</code>.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @return The footer.<a name="line.58"></a> |
| <FONT color="green">059</FONT> */<a name="line.59"></a> |
| <FONT color="green">060</FONT> public String getFooter() {<a name="line.60"></a> |
| <FONT color="green">061</FONT> return null;<a name="line.61"></a> |
| <FONT color="green">062</FONT> }<a name="line.62"></a> |
| <FONT color="green">063</FONT> <a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * If the layout handles the throwable object contained within<a name="line.66"></a> |
| <FONT color="green">067</FONT> * {@link LoggingEvent}, then the layout should return<a name="line.67"></a> |
| <FONT color="green">068</FONT> * {@code false}. Otherwise, if the layout ignores throwable<a name="line.68"></a> |
| <FONT color="green">069</FONT> * object, then the layout should return {@code true}.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * If ignoresThrowable is true, the appender is responsible for<a name="line.70"></a> |
| <FONT color="green">071</FONT> * rendering the throwable.<a name="line.71"></a> |
| <FONT color="green">072</FONT> * <p/><a name="line.72"></a> |
| <FONT color="green">073</FONT> * <p>The {@link SimpleLayout}, {@link TTCCLayout}, {@link<a name="line.73"></a> |
| <FONT color="green">074</FONT> * PatternLayout} all return {@code true}. The {@link<a name="line.74"></a> |
| <FONT color="green">075</FONT> * org.apache.log4j.xml.XMLLayout} returns {@code false}.<a name="line.75"></a> |
| <FONT color="green">076</FONT> * @return true if the Layout ignores Throwables.<a name="line.76"></a> |
| <FONT color="green">077</FONT> *<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @since 0.8.4<a name="line.78"></a> |
| <FONT color="green">079</FONT> */<a name="line.79"></a> |
| <FONT color="green">080</FONT> public abstract boolean ignoresThrowable();<a name="line.80"></a> |
| <FONT color="green">081</FONT> }<a name="line.81"></a> |
| <FONT color="green">082</FONT> <a name="line.82"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
