<!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: LoggingEventPatternConverter 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_logging_event_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> </div>
<div class="headertitle">
<h1>LoggingEventPatternConverter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::pattern::LoggingEventPatternConverter" --><!-- doxytag: inherits="log4cxx::pattern::PatternConverter" -->
<p><a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html" title="LoggingEventPatternConverter is a base class for pattern converters that can format information from ...">LoggingEventPatternConverter</a> is a base class for pattern converters that can format information from instances of LoggingEvent.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">log4cxx::pattern::PatternConverter</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1pattern_1_1_date_pattern_converter.html">DatePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_file_location_pattern_converter.html">FileLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_full_location_pattern_converter.html">FullLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_level_pattern_converter.html">LevelPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_line_location_pattern_converter.html">LineLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html">LineSeparatorPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_literal_pattern_converter.html">LiteralPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_message_pattern_converter.html">MessagePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_method_location_pattern_converter.html">MethodLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_name_pattern_converter.html">NamePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_n_d_c_pattern_converter.html">NDCPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_properties_pattern_converter.html">PropertiesPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html">RelativeTimePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_thread_pattern_converter.html">ThreadPatternConverter</a>, and <a class="el" href="classlog4cxx_1_1pattern_1_1_throwable_information_pattern_converter.html">ThrowableInformationPatternConverter</a>.</p>
<p><a href="classlog4cxx_1_1pattern_1_1_logging_event_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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#add24a40209b961a2e87645b000171bd5">format</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> &event, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &toAppendTo, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats an event into a string buffer. <a href="#add24a40209b961a2e87645b000171bd5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#a39af815814e5c3011ed62175104853ed">format</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::helpers::ObjectPtr</a> &obj, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &toAppendTo, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#a54accf71f24c8879b3dda4f62bb4dc0d">handlesThrowable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normally pattern converters are not meant to handle Exceptions although few pattern converters might. <a href="#a54accf71f24c8879b3dda4f62bb4dc0d"></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_logging_event_pattern_converter.html#af503d35027e5840903773e0d3d56d1c9">LoggingEventPatternConverter</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">Constructs an instance of <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html" title="LoggingEventPatternConverter is a base class for pattern converters that can format information from ...">LoggingEventPatternConverter</a>. <a href="#af503d35027e5840903773e0d3d56d1c9"></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_logging_event_pattern_converter.html" title="LoggingEventPatternConverter is a base class for pattern converters that can format information from ...">LoggingEventPatternConverter</a> is a base class for pattern converters that can format information from instances of LoggingEvent. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af503d35027e5840903773e0d3d56d1c9"></a><!-- doxytag: member="log4cxx::pattern::LoggingEventPatternConverter::LoggingEventPatternConverter" ref="af503d35027e5840903773e0d3d56d1c9" 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_logging_event_pattern_converter.html">LoggingEventPatternConverter</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>Constructs an instance of <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html" title="LoggingEventPatternConverter is a base class for pattern converters that can format information from ...">LoggingEventPatternConverter</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>name of converter. </td></tr>
<tr><td class="paramname">style</td><td>CSS style for output. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="add24a40209b961a2e87645b000171bd5"></a><!-- doxytag: member="log4cxx::pattern::LoggingEventPatternConverter::format" ref="add24a40209b961a2e87645b000171bd5" args="(const log4cxx::spi::LoggingEventPtr &event, LogString &toAppendTo, log4cxx::helpers::Pool &p) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></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"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats an event into a string buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>event to format, may not be null. </td></tr>
<tr><td class="paramname">toAppendTo</td><td>string buffer to which the formatted event will be appended. May not be null. </td></tr>
<tr><td class="paramname">p</td><td>pool for memory allocations needing during format. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4cxx_1_1pattern_1_1_class_name_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">ClassNamePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_date_pattern_converter.html#a8a06c4c03ab255664c22eab323585946">DatePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_file_location_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">FileLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_full_location_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">FullLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_level_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LevelPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_line_location_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LineLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LineSeparatorPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_literal_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LiteralPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_logger_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LoggerPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_message_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">MessagePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_method_location_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">MethodLocationPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_n_d_c_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">NDCPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_properties_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">PropertiesPatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">RelativeTimePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_thread_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">ThreadPatternConverter</a>, and <a class="el" href="classlog4cxx_1_1pattern_1_1_throwable_information_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">ThrowableInformationPatternConverter</a>.</p>
</div>
</div>
<a class="anchor" id="a39af815814e5c3011ed62175104853ed"></a><!-- doxytag: member="log4cxx::pattern::LoggingEventPatternConverter::format" ref="a39af815814e5c3011ed62175104853ed" args="(const log4cxx::helpers::ObjectPtr &obj, LogString &toAppendTo, log4cxx::helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void format </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>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></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"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1pattern_1_1_date_pattern_converter.html#a8604620453b4a9d9e17db0053fa9c559">DatePatternConverter</a>, <a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html#a39af815814e5c3011ed62175104853ed">LineSeparatorPatternConverter</a>, and <a class="el" href="classlog4cxx_1_1pattern_1_1_literal_pattern_converter.html#a39af815814e5c3011ed62175104853ed">LiteralPatternConverter</a>.</p>
</div>
</div>
<a class="anchor" id="a54accf71f24c8879b3dda4f62bb4dc0d"></a><!-- doxytag: member="log4cxx::pattern::LoggingEventPatternConverter::handlesThrowable" ref="a54accf71f24c8879b3dda4f62bb4dc0d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool handlesThrowable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Normally pattern converters are not meant to handle Exceptions although few pattern converters might. </p>
<p>By examining the return values for this method, the containing layout will determine whether it handles throwables or not.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this <a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a> handles throwables </dd></dl>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1pattern_1_1_throwable_information_pattern_converter.html#a9e49eef48526461464b1783eae464b6f">ThrowableInformationPatternConverter</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="loggingeventpatternconverter_8h.html">loggingeventpatternconverter.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_logging_event_pattern_converter.html">LoggingEventPatternConverter</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>
