blob: 633da55e6d218c787fe9ed3c1c2c32dc9f575ef7 [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.core.pattern;<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 name="line.20"></a>
<FONT color="green">021</FONT> * &lt;p&gt;AbstractPatternConverter is an abstract class that provides the<a name="line.21"></a>
<FONT color="green">022</FONT> * formatting functionality that derived classes need.<a name="line.22"></a>
<FONT color="green">023</FONT> * &lt;p/&gt;<a name="line.23"></a>
<FONT color="green">024</FONT> * &lt;p&gt;Conversion specifiers in a conversion patterns are parsed to<a name="line.24"></a>
<FONT color="green">025</FONT> * individual PatternConverters. Each of which is responsible for<a name="line.25"></a>
<FONT color="green">026</FONT> * converting an object in a converter specific manner.<a name="line.26"></a>
<FONT color="green">027</FONT> */<a name="line.27"></a>
<FONT color="green">028</FONT> public abstract class AbstractPatternConverter implements PatternConverter {<a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Converter name.<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> private final String name;<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> /**<a name="line.34"></a>
<FONT color="green">035</FONT> * Converter style name.<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> private final String style;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Create a new pattern converter.<a name="line.40"></a>
<FONT color="green">041</FONT> *<a name="line.41"></a>
<FONT color="green">042</FONT> * @param name name for pattern converter.<a name="line.42"></a>
<FONT color="green">043</FONT> * @param style CSS style for formatted output.<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> protected AbstractPatternConverter(final String name, final String style) {<a name="line.45"></a>
<FONT color="green">046</FONT> this.name = name;<a name="line.46"></a>
<FONT color="green">047</FONT> this.style = style;<a name="line.47"></a>
<FONT color="green">048</FONT> }<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /**<a name="line.50"></a>
<FONT color="green">051</FONT> * This method returns the name of the conversion pattern.<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;p/&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * The name can be useful to certain Layouts such as HTMLLayout.<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * @return the name of the conversion pattern<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> public final String getName() {<a name="line.57"></a>
<FONT color="green">058</FONT> return name;<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /**<a name="line.61"></a>
<FONT color="green">062</FONT> * This method returns the CSS style class that should be applied to<a name="line.62"></a>
<FONT color="green">063</FONT> * the LoggingEvent passed as parameter, which can be null.<a name="line.63"></a>
<FONT color="green">064</FONT> * &lt;p/&gt;<a name="line.64"></a>
<FONT color="green">065</FONT> * This information is currently used only by HTMLLayout.<a name="line.65"></a>
<FONT color="green">066</FONT> *<a name="line.66"></a>
<FONT color="green">067</FONT> * @param e null values are accepted<a name="line.67"></a>
<FONT color="green">068</FONT> * @return the name of the conversion pattern<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> public String getStyleClass(Object e) {<a name="line.70"></a>
<FONT color="green">071</FONT> return style;<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> }<a name="line.73"></a>
</PRE>
</BODY>
</HTML>