<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: PatternConverter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1pattern_1_1_pattern_converter.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> </div>
<div class="headertitle">
<h1>PatternConverter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::pattern::PatternConverter" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1pattern_1_1_integer_pattern_converter.html">IntegerPatternConverter</a>, and <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html">LoggingEventPatternConverter</a>.</p>
<p><a href="classlog4cxx_1_1pattern_1_1_pattern_converter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html#a3ad0252a0a90d42e1651f41de2237ef2">getStyleClass</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::helpers::ObjectPtr</a> &e) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null. <a href="#a3ad0252a0a90d42e1651f41de2237ef2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html#a25fcc227ebdb57c4c341466ea76b1239">PatternConverter</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &name, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &style)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new pattern converter. <a href="#a25fcc227ebdb57c4c341466ea76b1239"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html#a70a4b8169b80539ab3f61dd0d6c9b7e3">~PatternConverter</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html#ab7885f06f40816fff7278404cfb940b1">append</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &toAppendTo, const std::string &src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends content in the locale code page to a LogString. <a href="#ab7885f06f40816fff7278404cfb940b1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a> is an abstract class that provides the formatting functionality that derived classes need.</p>
<p>Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. Each of which is responsible for converting an object in a converter specific manner. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a25fcc227ebdb57c4c341466ea76b1239"></a><!-- doxytag: member="log4cxx::pattern::PatternConverter::PatternConverter" ref="a25fcc227ebdb57c4c341466ea76b1239" args="(const LogString &name, const LogString &style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>style</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new pattern converter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>name for pattern converter. </td></tr>
<tr><td class="paramname">style</td><td>CSS style for formatted output. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a70a4b8169b80539ab3f61dd0d6c9b7e3"></a><!-- doxytag: member="log4cxx::pattern::PatternConverter::~PatternConverter" ref="a70a4b8169b80539ab3f61dd0d6c9b7e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab7885f06f40816fff7278404cfb940b1"></a><!-- doxytag: member="log4cxx::pattern::PatternConverter::append" ref="ab7885f06f40816fff7278404cfb940b1" args="(LogString &toAppendTo, const std::string &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void append </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>toAppendTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Appends content in the locale code page to a LogString. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">toAppendTo</td><td>string to which content is appended. </td></tr>
<tr><td class="paramname">src</td><td>content. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3ad0252a0a90d42e1651f41de2237ef2"></a><!-- doxytag: member="log4cxx::pattern::PatternConverter::getStyleClass" ref="a3ad0252a0a90d42e1651f41de2237ef2" args="(const log4cxx::helpers::ObjectPtr &e) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getStyleClass </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::helpers::ObjectPtr</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null. </p>
<p>This information is currently used only by <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html" title="This layout outputs events in a HTML table.">HTMLLayout</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>null values are accepted </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the name of the conversion pattern </dd></dl>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1pattern_1_1_level_pattern_converter.html#afdfdfaf9effb6340bef8e5ae01577a0d">LevelPatternConverter</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="patternconverter_8h.html">patternconverter.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1pattern.html">pattern</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
