blob: d4badea213cd4e4e47a3de6b3ee49ceba961d338 [file] [log] [blame]
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Apache log4cxx: LoggingEventPatternConverter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://logging.apache.org/log4cxx">Apache log4cxx</a>
&#160;<span id="projectnumber">Version 0.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LoggingEventPatternConverter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<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="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for LoggingEventPatternConverter:</div>
<div class="dyncontent">
<div class="center">
<img src="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.png" usemap="#LoggingEventPatternConverter_map" alt=""/>
<map id="LoggingEventPatternConverter_map" name="LoggingEventPatternConverter_map">
<area href="classlog4cxx_1_1pattern_1_1_pattern_converter.html" alt="PatternConverter" shape="rect" coords="0,112,230,136"/>
<area href="classlog4cxx_1_1helpers_1_1_object_impl.html" title="Implementation class for Object. " alt="ObjectImpl" shape="rect" coords="0,56,230,80"/>
<area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="0,0,230,24"/>
<area href="classlog4cxx_1_1pattern_1_1_date_pattern_converter.html" title="Convert and format the event&#39;s date in a StringBuffer. " alt="DatePatternConverter" shape="rect" coords="240,224,470,248"/>
<area href="classlog4cxx_1_1pattern_1_1_file_location_pattern_converter.html" title="Return the event&#39;s line location information in a StringBuffer. " alt="FileLocationPatternConverter" shape="rect" coords="240,280,470,304"/>
<area href="classlog4cxx_1_1pattern_1_1_full_location_pattern_converter.html" title="Format the event&#39;s line location information. " alt="FullLocationPatternConverter" shape="rect" coords="240,336,470,360"/>
<area href="classlog4cxx_1_1pattern_1_1_level_pattern_converter.html" title="Return the event&#39;s level in a StringBuffer. " alt="LevelPatternConverter" shape="rect" coords="240,392,470,416"/>
<area href="classlog4cxx_1_1pattern_1_1_line_location_pattern_converter.html" title="Format the event&#39;s line location information. " alt="LineLocationPatternConverter" shape="rect" coords="240,448,470,472"/>
<area href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html" title="Formats a line separator. " alt="LineSeparatorPatternConverter" shape="rect" coords="240,504,470,528"/>
<area href="classlog4cxx_1_1pattern_1_1_literal_pattern_converter.html" title="Formats a string literal. " alt="LiteralPatternConverter" shape="rect" coords="240,560,470,584"/>
<area href="classlog4cxx_1_1pattern_1_1_message_pattern_converter.html" title="Formats the message of an logging event. " alt="MessagePatternConverter" shape="rect" coords="240,616,470,640"/>
<area href="classlog4cxx_1_1pattern_1_1_method_location_pattern_converter.html" title="Return the event&#39;s line location information in a StringBuffer. " alt="MethodLocationPatternConverter" shape="rect" coords="240,672,470,696"/>
<area href="classlog4cxx_1_1pattern_1_1_name_pattern_converter.html" title="Base class for other pattern converters which can return only parts of their name. " alt="NamePatternConverter" shape="rect" coords="240,728,470,752"/>
<area href="classlog4cxx_1_1pattern_1_1_n_d_c_pattern_converter.html" title="Return the event&#39;s NDC in a StringBuffer. " alt="NDCPatternConverter" shape="rect" coords="240,784,470,808"/>
<area href="classlog4cxx_1_1pattern_1_1_properties_pattern_converter.html" title="Able to handle the contents of the LoggingEvent&#39;s Property bundle and either output the entire conten..." alt="PropertiesPatternConverter" shape="rect" coords="240,840,470,864"/>
<area href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html" title="Format the relative time in milliseconds. " alt="RelativeTimePatternConverter" shape="rect" coords="240,896,470,920"/>
<area href="classlog4cxx_1_1pattern_1_1_thread_pattern_converter.html" title="Formats the event thread name. " alt="ThreadPatternConverter" shape="rect" coords="240,952,470,976"/>
<area href="classlog4cxx_1_1pattern_1_1_throwable_information_pattern_converter.html" title="Outputs the ThrowableInformation portion of the LoggingiEvent as a full stacktrace unless this conver..." alt="ThrowableInformationPatternConverter" shape="rect" coords="240,1008,470,1032"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab161008b5e6e4694e175f80a6a5830fc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#ab161008b5e6e4694e175f80a6a5830fc">format</a> (const <a class="el" href="namespacelog4cxx_1_1spi.html#ab5abd68f0fb303c6d5f5f7d1ff49b3a6">log4cxx::spi::LoggingEventPtr</a> &amp;event, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;toAppendTo, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;p) const =0</td></tr>
<tr class="memdesc:ab161008b5e6e4694e175f80a6a5830fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats an event into a string buffer. <a href="#ab161008b5e6e4694e175f80a6a5830fc">More...</a><br /></td></tr>
<tr class="separator:ab161008b5e6e4694e175f80a6a5830fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39af815814e5c3011ed62175104853ed"><td class="memItemLeft" align="right" valign="top">void&#160;</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="namespacelog4cxx_1_1helpers.html#aa808d0071a7cbb3a7e9214ee261c844a">log4cxx::helpers::ObjectPtr</a> &amp;obj, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;toAppendTo, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;p) const </td></tr>
<tr class="separator:a39af815814e5c3011ed62175104853ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54accf71f24c8879b3dda4f62bb4dc0d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</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 class="memdesc:a54accf71f24c8879b3dda4f62bb4dc0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normally pattern converters are not meant to handle Exceptions although few pattern converters might. <a href="#a54accf71f24c8879b3dda4f62bb4dc0d">More...</a><br /></td></tr>
<tr class="separator:a54accf71f24c8879b3dda4f62bb4dc0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1pattern_1_1_pattern_converter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a></td></tr>
<tr class="memitem:a3ad0252a0a90d42e1651f41de2237ef2 inherit pub_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>&#160;</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="namespacelog4cxx_1_1helpers.html#aa808d0071a7cbb3a7e9214ee261c844a">log4cxx::helpers::ObjectPtr</a> &amp;e) const </td></tr>
<tr class="memdesc:a3ad0252a0a90d42e1651f41de2237ef2 inherit pub_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="mdescLeft">&#160;</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">More...</a><br /></td></tr>
<tr class="separator:a3ad0252a0a90d42e1651f41de2237ef2 inherit pub_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1_object_impl')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">ObjectImpl</a></td></tr>
<tr class="memitem:a5e6e9fc30dc1f098fee72d516ea0bad0 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a5e6e9fc30dc1f098fee72d516ea0bad0">ObjectImpl</a> ()</td></tr>
<tr class="separator:a5e6e9fc30dc1f098fee72d516ea0bad0 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb974728bb3cb991285140c1aa57eed7 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#abb974728bb3cb991285140c1aa57eed7">~ObjectImpl</a> ()</td></tr>
<tr class="separator:abb974728bb3cb991285140c1aa57eed7 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr>
<tr class="separator:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr>
<tr class="separator:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object.html">Object</a></td></tr>
<tr class="memitem:ae7b62e37794f297c0cede40ed0e84fcd inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">helpers::Class</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ae7b62e37794f297c0cede40ed0e84fcd">getClass</a> () const </td></tr>
<tr class="separator:ae7b62e37794f297c0cede40ed0e84fcd inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5">~Object</a> ()</td></tr>
<tr class="separator:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a0ab1bb19059c1de23f8a35cdbc0b6a5c">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &amp;clazz) const =0</td></tr>
<tr class="separator:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04b3422e17b0a882538bbc99833ab9df inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a04b3422e17b0a882538bbc99833ab9df">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &amp;clazz) const =0</td></tr>
<tr class="separator:a04b3422e17b0a882538bbc99833ab9df inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af503d35027e5840903773e0d3d56d1c9"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;name, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;style)</td></tr>
<tr class="memdesc:af503d35027e5840903773e0d3d56d1c9"><td class="mdescLeft">&#160;</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">More...</a><br /></td></tr>
<tr class="separator:af503d35027e5840903773e0d3d56d1c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a></td></tr>
<tr class="memitem:a25fcc227ebdb57c4c341466ea76b1239 inherit pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;name, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;style)</td></tr>
<tr class="memdesc:a25fcc227ebdb57c4c341466ea76b1239 inherit pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new pattern converter. <a href="#a25fcc227ebdb57c4c341466ea76b1239">More...</a><br /></td></tr>
<tr class="separator:a25fcc227ebdb57c4c341466ea76b1239 inherit pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70a4b8169b80539ab3f61dd0d6c9b7e3 inherit pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html#a70a4b8169b80539ab3f61dd0d6c9b7e3">~PatternConverter</a> ()</td></tr>
<tr class="separator:a70a4b8169b80539ab3f61dd0d6c9b7e3 inherit pro_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classlog4cxx_1_1helpers_1_1_object')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object.html">Object</a></td></tr>
<tr class="memitem:a0bdbda4effe8938c1aca6d4397e5a39d inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">helpers::Class</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a0bdbda4effe8938c1aca6d4397e5a39d">getStaticClass</a> ()</td></tr>
<tr class="separator:a0bdbda4effe8938c1aca6d4397e5a39d inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50ec9288d0b7e3140dee8e24ee74a212 inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4cxx_1_1helpers_1_1_class_registration.html">log4cxx::helpers::ClassRegistration</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a50ec9288d0b7e3140dee8e24ee74a212">registerClass</a> ()</td></tr>
<tr class="separator:a50ec9288d0b7e3140dee8e24ee74a212 inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_classlog4cxx_1_1pattern_1_1_pattern_converter')"><img src="closed.png" alt="-"/>&#160;Static Protected Member Functions inherited from <a class="el" href="classlog4cxx_1_1pattern_1_1_pattern_converter.html">PatternConverter</a></td></tr>
<tr class="memitem:ab7885f06f40816fff7278404cfb940b1 inherit pro_static_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memItemLeft" align="right" valign="top">static void&#160;</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> &amp;toAppendTo, const std::string &amp;src)</td></tr>
<tr class="memdesc:ab7885f06f40816fff7278404cfb940b1 inherit pro_static_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Appends content in the locale code page to a LogString. <a href="#ab7885f06f40816fff7278404cfb940b1">More...</a><br /></td></tr>
<tr class="separator:ab7885f06f40816fff7278404cfb940b1 inherit pro_static_methods_classlog4cxx_1_1pattern_1_1_pattern_converter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">ObjectImpl</a></td></tr>
<tr class="memitem:a88f2ae00c84f3f309965e6588ed158d4 inherit pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">unsigned int volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a88f2ae00c84f3f309965e6588ed158d4">ref</a></td></tr>
<tr class="separator:a88f2ae00c84f3f309965e6588ed158d4 inherit pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">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><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af503d35027e5840903773e0d3d56d1c9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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> &amp;&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>style</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </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 class="params"><dt>Parameters</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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab161008b5e6e4694e175f80a6a5830fc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx_1_1spi.html#ab5abd68f0fb303c6d5f5f7d1ff49b3a6">log4cxx::spi::LoggingEventPtr</a> &amp;&#160;</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> &amp;&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Formats an event into a string buffer. </p>
<dl class="params"><dt>Parameters</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_date_pattern_converter.html#a8a06c4c03ab255664c22eab323585946">DatePatternConverter</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_throwable_information_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">ThrowableInformationPatternConverter</a>, <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_logger_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LoggerPatternConverter</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_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_line_location_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">LineLocationPatternConverter</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_method_location_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">MethodLocationPatternConverter</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_n_d_c_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">NDCPatternConverter</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_relative_time_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">RelativeTimePatternConverter</a>, and <a class="el" href="classlog4cxx_1_1pattern_1_1_thread_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">ThreadPatternConverter</a>.</p>
</div>
</div>
<a class="anchor" id="a39af815814e5c3011ed62175104853ed"></a>
<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="namespacelog4cxx_1_1helpers.html#aa808d0071a7cbb3a7e9214ee261c844a">log4cxx::helpers::ObjectPtr</a> &amp;&#160;</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> &amp;&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>p</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a54accf71f24c8879b3dda4f62bb4dc0d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool handlesThrowable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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="section return"><dt>Returns</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><!-- contents -->
</div><!-- doc-content -->
<!--
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>