| <!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: PatternLayout 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> |
|  <span id="projectnumber">Version 0.11.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 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 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><!-- 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_1_pattern_layout.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> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="classlog4cxx_1_1_pattern_layout-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">PatternLayout Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A flexible layout configurable with pattern string. |
| <a href="classlog4cxx_1_1_pattern_layout.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for PatternLayout:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classlog4cxx_1_1_pattern_layout.png" usemap="#PatternLayout_map" alt=""/> |
| <map id="PatternLayout_map" name="PatternLayout_map"> |
| <area href="classlog4cxx_1_1_layout.html" title="Extend this abstract class to create your own log layout format. " alt="Layout" shape="rect" coords="52,112,146,136"/> |
| <area href="classlog4cxx_1_1spi_1_1_option_handler.html" title="A string based interface to configure package components. " alt="OptionHandler" shape="rect" coords="0,56,94,80"/> |
| <area href="classlog4cxx_1_1helpers_1_1_object_impl.html" title="Implementation class for Object. " alt="ObjectImpl" shape="rect" coords="104,56,198,80"/> |
| <area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="0,0,94,24"/> |
| <area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="104,0,198,24"/> |
| </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:a8d222ae827db68cb2ec938d679c00b2f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#a8d222ae827db68cb2ec938d679c00b2f">PatternLayout</a> ()</td></tr> |
| <tr class="memdesc:a8d222ae827db68cb2ec938d679c00b2f"><td class="mdescLeft"> </td><td class="mdescRight">Does nothing. <a href="#a8d222ae827db68cb2ec938d679c00b2f">More...</a><br /></td></tr> |
| <tr class="separator:a8d222ae827db68cb2ec938d679c00b2f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a104b395281f6088b7a4117cb7d42ecaa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#a104b395281f6088b7a4117cb7d42ecaa">PatternLayout</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &pattern)</td></tr> |
| <tr class="memdesc:a104b395281f6088b7a4117cb7d42ecaa"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string. ">PatternLayout</a> using the supplied conversion pattern. <a href="#a104b395281f6088b7a4117cb7d42ecaa">More...</a><br /></td></tr> |
| <tr class="separator:a104b395281f6088b7a4117cb7d42ecaa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c480a3e2a7cd0926354df68221459b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#a3c480a3e2a7cd0926354df68221459b1">setConversionPattern</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &conversionPattern)</td></tr> |
| <tr class="memdesc:a3c480a3e2a7cd0926354df68221459b1"><td class="mdescLeft"> </td><td class="mdescRight">Set the <b>ConversionPattern</b> option. <a href="#a3c480a3e2a7cd0926354df68221459b1">More...</a><br /></td></tr> |
| <tr class="separator:a3c480a3e2a7cd0926354df68221459b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af5dad3df8eb7d15aaf7863b515405b6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#af5dad3df8eb7d15aaf7863b515405b6b">getConversionPattern</a> () const </td></tr> |
| <tr class="memdesc:af5dad3df8eb7d15aaf7863b515405b6b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b>ConversionPattern</b> option. <a href="#af5dad3df8eb7d15aaf7863b515405b6b">More...</a><br /></td></tr> |
| <tr class="separator:af5dad3df8eb7d15aaf7863b515405b6b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1f3ced78d335ec9c2b800d6d5aa3ef8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr> |
| <tr class="memdesc:af1f3ced78d335ec9c2b800d6d5aa3ef8"><td class="mdescLeft"> </td><td class="mdescRight">Call createPatternParser. <a href="#af1f3ced78d335ec9c2b800d6d5aa3ef8">More...</a><br /></td></tr> |
| <tr class="separator:af1f3ced78d335ec9c2b800d6d5aa3ef8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aee5023c29cca9dc68164b22a01cb7c6e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr> |
| <tr class="memdesc:aee5023c29cca9dc68164b22a01cb7c6e"><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#aee5023c29cca9dc68164b22a01cb7c6e">More...</a><br /></td></tr> |
| <tr class="separator:aee5023c29cca9dc68164b22a01cb7c6e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5796c8d5c4ed8ceae2cb9ebb1db75518"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#a5796c8d5c4ed8ceae2cb9ebb1db75518">ignoresThrowable</a> () const </td></tr> |
| <tr class="memdesc:a5796c8d5c4ed8ceae2cb9ebb1db75518"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string. ">PatternLayout</a> does not handle the throwable contained within <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvents</a>. <a href="#a5796c8d5c4ed8ceae2cb9ebb1db75518">More...</a><br /></td></tr> |
| <tr class="separator:a5796c8d5c4ed8ceae2cb9ebb1db75518"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a79cba5d2db27cc6537de868018b72d9c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#a79cba5d2db27cc6537de868018b72d9c">format</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &output, const <a class="el" href="namespacelog4cxx_1_1spi.html#ab5abd68f0fb303c6d5f5f7d1ff49b3a6">spi::LoggingEventPtr</a> &event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool) const </td></tr> |
| <tr class="memdesc:a79cba5d2db27cc6537de868018b72d9c"><td class="mdescLeft"> </td><td class="mdescRight">Produces a formatted string as specified by the conversion pattern. <a href="#a79cba5d2db27cc6537de868018b72d9c">More...</a><br /></td></tr> |
| <tr class="separator:a79cba5d2db27cc6537de868018b72d9c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classlog4cxx_1_1_layout"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1_layout')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1_layout.html">Layout</a></td></tr> |
| <tr class="memitem:a509ff848be1289bfd6ce0ea98dbf6212 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#a509ff848be1289bfd6ce0ea98dbf6212">~Layout</a> ()</td></tr> |
| <tr class="separator:a509ff848be1289bfd6ce0ea98dbf6212 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1_layout"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr> |
| <tr class="separator:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1_layout"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr> |
| <tr class="separator:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d61ef61f2aaf3923ef0a16fc6728dc7 inherit pub_methods_classlog4cxx_1_1_layout"><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_1_layout.html#a8d61ef61f2aaf3923ef0a16fc6728dc7">getContentType</a> () const </td></tr> |
| <tr class="memdesc:a8d61ef61f2aaf3923ef0a16fc6728dc7 inherit pub_methods_classlog4cxx_1_1_layout"><td class="mdescLeft"> </td><td class="mdescRight">Returns the content type output by this layout. <a href="#a8d61ef61f2aaf3923ef0a16fc6728dc7">More...</a><br /></td></tr> |
| <tr class="separator:a8d61ef61f2aaf3923ef0a16fc6728dc7 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad1b07d688e39f3a8d71acec8f6d7b878 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#ad1b07d688e39f3a8d71acec8f6d7b878">appendHeader</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &output, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr> |
| <tr class="memdesc:ad1b07d688e39f3a8d71acec8f6d7b878 inherit pub_methods_classlog4cxx_1_1_layout"><td class="mdescLeft"> </td><td class="mdescRight">Append the header for the layout format. <a href="#ad1b07d688e39f3a8d71acec8f6d7b878">More...</a><br /></td></tr> |
| <tr class="separator:ad1b07d688e39f3a8d71acec8f6d7b878 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae8f7d8f894b39b251cada7674bdfe8d2 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#ae8f7d8f894b39b251cada7674bdfe8d2">appendFooter</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &output, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr> |
| <tr class="memdesc:ae8f7d8f894b39b251cada7674bdfe8d2 inherit pub_methods_classlog4cxx_1_1_layout"><td class="mdescLeft"> </td><td class="mdescRight">Append the footer for the layout format. <a href="#ae8f7d8f894b39b251cada7674bdfe8d2">More...</a><br /></td></tr> |
| <tr class="separator:ae8f7d8f894b39b251cada7674bdfe8d2 inherit pub_methods_classlog4cxx_1_1_layout"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classlog4cxx_1_1spi_1_1_option_handler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1spi_1_1_option_handler')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html">OptionHandler</a></td></tr> |
| <tr class="memitem:ad773ac49843844af53fe553912ed63e5 inherit pub_methods_classlog4cxx_1_1spi_1_1_option_handler"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#ad773ac49843844af53fe553912ed63e5">~OptionHandler</a> ()</td></tr> |
| <tr class="separator:ad773ac49843844af53fe553912ed63e5 inherit pub_methods_classlog4cxx_1_1spi_1_1_option_handler"><td class="memSeparator" colspan="2"> </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="-"/> 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> & </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"> </td></tr> |
| <tr class="memitem:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td></tr> |
| <tr class="memitem:a3604a5fb08f7048d41b51a3943740b96 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a3604a5fb08f7048d41b51a3943740b96">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a3604a5fb08f7048d41b51a3943740b96 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a7744a4efdb699356cef215613903c3 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a5a7744a4efdb699356cef215613903c3">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a5a7744a4efdb699356cef215613903c3 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </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"> </td></tr> |
| <tr class="memitem:abb974728bb3cb991285140c1aa57eed7 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">virtual </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"> </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:a9f5587f187a5b63ec771af5b7ca2042f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacelog4cxx_1_1pattern.html#af3e2bcdd3fe2edd7071727492a4efa7d">log4cxx::pattern::PatternMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_pattern_layout.html#a9f5587f187a5b63ec771af5b7ca2042f">getFormatSpecifiers</a> ()</td></tr> |
| <tr class="separator:a9f5587f187a5b63ec771af5b7ca2042f"><td class="memSeparator" colspan="2"> </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="-"/> 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> & </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"> </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> & </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"> </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="-"/> 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 </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"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A flexible layout configurable with pattern string. </p> |
| <p>The goal of this class is to <a class="el" href="classlog4cxx_1_1_pattern_layout.html#a79cba5d2db27cc6537de868018b72d9c" title="Produces a formatted string as specified by the conversion pattern. ">format</a> a <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> and return the results as a string. The results depend on the <em>conversion pattern</em>. </p> |
| <p>The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern is composed of literal text and format control expressions called <em>conversion specifiers</em>. </p> |
| <p><em>You are free to insert any literal text within the conversion pattern.</em> </p> |
| <p>Each conversion specifier starts with a percent sign (%) and is followed by optional <em>format modifiers</em> and a <em>conversion character</em>. The conversion character specifies the type of data, e.g. logger, level, date, thread name. The format modifiers control such things as field width, padding, left and right justification. The following is a simple example. </p> |
| <p>Let the conversion pattern be <b>"%-5p [%t]: %m%n"</b> and assume that the <a class="el" href="namespacelog4cxx.html">log4cxx</a> environment was set to use a <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string. ">PatternLayout</a>. Then the statements </p><pre> |
| LoggerPtr root = Logger::getRoot(); |
| root->debug("Message 1"); |
| root->warn("Message 2");</pre><p> would yield the output </p><pre> |
| DEBUG [main]: Message 1 |
| WARN [main]: Message 2</pre> <p>Note that there is no explicit separator between text and conversion specifiers. The pattern parser knows when it has reached the end of a conversion specifier when it reads a conversion character. In the example above the conversion specifier <b>%-5p</b> means the level of the logging event should be left justified to a width of five characters. </p> |
| <p>The recognized conversion characters are:</p> |
| <table border="1" cellpadding="8"> |
| <tr> |
| <th align="center"><b>Conversion Character</b> </th><th align="center"><b>Effect</b> </th></tr> |
| <tr> |
| <td align="center"><b>c</b> </td><td><p class="starttd">Used to output the logger of the logging event. The logger conversion specifier can be optionally followed by <em>precision specifier</em>, that is a decimal constant in brackets. </p> |
| <p>If a precision specifier is given, then only the corresponding number of right most components of the logger name will be printed. By default the logger name is printed in full. </p> |
| <p></p> |
| <p>For example, for the logger name "a.b.c" the pattern <b>c{2}</b> will output "b.c". </p> |
| <p class="endtd"></p> |
| </td></tr> |
| <tr> |
| <td align="center"><p class="starttd"></p> |
| <p><b>C</b></p> |
| <p></p> |
| <p><b>class</b></p> |
| <p class="endtd"></p> |
| </td><td><p class="starttd">Used to output the class of the issuer of the logging event if the compiler used supports a macro to retrieve the method of the currently compiled line and if the LOG4CXX_TRACE-like macros are used to issue a logging request. In this case the macro LOG4CXX_* is expanded at compile time to generate location info of the logging event and adds the method name, besides file and line, if available. In most cases the provided method contains the classname and can therefore be retrieved form the location info as needed. </p> |
| <p>Currently supported compilers are those from Microsoft, GNU-C and Borland. </p> |
| <p class="endtd"></p> |
| </td></tr> |
| <tr> |
| <td align="center"><b>d</b> </td><td>Used to output the date of the logging event. The date conversion specifier may be followed by a set of braces containing a date and time pattern string compatible with java.text.SimpleDateFormat, <em>ABSOLUTE</em>, <em>DATE</em> or <em>ISO8601</em>. For example, <b>d{HH:mm:ss,SSS}</b>, <b>d{dd MMM yyyy HH:mm:ss,SSS}</b> or <b>d{DATE}</b>. If no date format specifier is given then ISO8601 format is assumed. </td></tr> |
| <tr> |
| <td align="center"><b>F</b> </td><td>Used to output the file name where the logging request was issued. </td></tr> |
| <tr> |
| <td align="center"><b>l</b> </td><td>Used to output location information of the caller which generated the logging event. </td></tr> |
| <tr> |
| <td align="center"><b>L</b> </td><td>Used to output the line number from where the logging request was issued. </td></tr> |
| <tr> |
| <td align="center"><b>m</b> </td><td>Used to output the application supplied message associated with the logging event. </td></tr> |
| <tr> |
| <td align="center"><p class="starttd"><b>M</b> </p> |
| <p><b>method</b></p> |
| <p class="endtd"></p> |
| </td><td><p class="starttd">Used to output the method of the issuer of the logging event if the compiler used supports a macro to retrieve the method of the currently compiled line and if the LOG4CXX_TRACE-like macros are used to issue a logging request. In this case the macro LOG4CXX_* is expanded at compile time to generate location info of the logging event and adds the method name, besides file and line, if available. In most cases the provided method contains the classname which is ignored in every attempt to retrieve the method from the location info. </p> |
| <p>Currently supported compilers are those from Microsoft, GNU-C and Borland. </p> |
| <p class="endtd"></p> |
| </td></tr> |
| <tr> |
| <td align="center"><b>n</b> </td><td><p class="starttd">Outputs the platform dependent line separator character or characters. </p> |
| <p>This conversion character offers practically the same performance as using non-portable line separator strings such as "\n", or "\r\n". Thus, it is the preferred way of specifying a line separator. </p> |
| <p class="endtd"></p> |
| </td></tr> |
| <tr> |
| <td align="center"><b>p</b> </td><td>Used to output the level of the logging event. </td></tr> |
| <tr> |
| <td align="center"><b>r</b> </td><td>Used to output the number of milliseconds elapsed since the start of the application until the creation of the logging event. </td></tr> |
| <tr> |
| <td align="center"><b>t</b> </td><td>Used to output the name of the thread that generated the logging event. </td></tr> |
| <tr> |
| <td align="center"><b>x</b> </td><td>Used to output the <a class="el" href="classlog4cxx_1_1_n_d_c.html" title="the ndc class implements nested diagnostic contexts as defined by neil harrison in the article "patte...">NDC</a> (nested diagnostic context) associated with the thread that generated the logging event. </td></tr> |
| <tr> |
| <td align="center"><b>X</b> </td><td><p class="starttd">Used to output the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> (mapped diagnostic context) associated with the thread that generated the logging event. The <b>X</b> conversion character <em>must</em> be followed by the key for the map placed between braces, as in <b>X{clientNumber}</b> where <code>clientNumber</code> is the key. The value in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> corresponding to the key will be output. </p> |
| <p>See <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> class for more details.</p> |
| <p class="endtd"></p> |
| </td></tr> |
| <tr> |
| <td align="center"><b>%</b> </td><td>The sequence %% outputs a single percent sign. </td></tr> |
| </table> |
| <p>By default the relevant information is output as is. However, with the aid of format modifiers it is possible to change the minimum field width, the maximum field width and justification. </p> |
| <p>The optional format modifier is placed between the percent sign and the conversion character. </p> |
| <p>The first optional format modifier is the <em>left justification flag</em> which is just the minus (-) character. Then comes the optional <em>minimum field width</em> modifier. This is a decimal constant that represents the minimum number of characters to output. If the data item requires fewer characters, it is padded on either the left or the right until the minimum width is reached. The default is to pad on the left (right justify) but you can specify right padding with the left justification flag. The padding character is space. If the data item is larger than the minimum field width, the field is expanded to accommodate the data. The value is never truncated. </p> |
| <p>This behavior can be changed using the <em>maximum field width</em> modifier which is designated by a period followed by a decimal constant. If the data item is longer than the maximum field, then the extra characters are removed from the <em>beginning</em> of the data item and not from the end. For example, it the maximum field width is eight and the data item is ten characters long, then the first two characters of the data item are dropped. This behavior deviates from the printf function in C where truncation is done from the end. </p> |
| <p>Below are various format modifier examples for the logger conversion specifier.</p> |
| <table border="1" cellpadding="8"> |
| <tr> |
| <th align="center"><b>Format modifier</b> </th><th align="center"><b>left justify</b> </th><th align="center"><b>minimum width</b> </th><th align="center"><b>maximum width</b> </th><th align="center"><b>comment</b> </th></tr> |
| <tr> |
| <td align="center">%20c </td><td align="center">false </td><td align="center">20 </td><td align="center">none </td><td>Left pad with spaces if the logger name is less than 20 characters long. </td></tr> |
| <tr> |
| <td align="center">%-20c </td><td align="center">true </td><td align="center">20 </td><td align="center">none </td><td>Right pad with spaces if the logger name is less than 20 characters long. </td></tr> |
| <tr> |
| <td align="center">%.30c </td><td align="center">NA </td><td align="center">none </td><td align="center">30 </td><td>Truncate from the beginning if the logger name is longer than 30 characters. </td></tr> |
| <tr> |
| <td align="center">%20.30c </td><td align="center">false </td><td align="center">20 </td><td align="center">30 </td><td>Left pad with spaces if the logger name is shorter than 20 characters. However, if logger name is longer than 30 characters, then truncate from the beginning. </td></tr> |
| <tr> |
| <td align="center">%-20.30c </td><td align="center">true </td><td align="center">20 </td><td align="center">30 </td><td>Right pad with spaces if the logger name is shorter than 20 characters. However, if logger name is longer than 30 characters, then truncate from the beginning. </td></tr> |
| </table> |
| <p>Below are some examples of conversion patterns.</p> |
| <p><b>r [t] %-5p c x - m<br /> |
| </b></p> |
| <p>This is essentially the TTCC layout.</p> |
| <p><b>%-6r [%15.15t] %-5p %30.30c x - m<br /> |
| </b></p> |
| <p>Similar to the TTCC layout except that the relative time is right padded if less than 6 digits, thread name is right padded if less than 15 characters and truncated if longer and the logger name is left padded if shorter than 30 characters and truncated if longer. </p> |
| <p>The above text is largely inspired from Peter A. Darnell and Philip E. Margolis' highly recommended book "C -- a Software Engineering Approach", ISBN 0-387-97389-3. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a8d222ae827db68cb2ec938d679c00b2f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classlog4cxx_1_1_pattern_layout.html">PatternLayout</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Does nothing. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a104b395281f6088b7a4117cb7d42ecaa"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classlog4cxx_1_1_pattern_layout.html">PatternLayout</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> |
| <td class="paramname"><em>pattern</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string. ">PatternLayout</a> using the supplied conversion pattern. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af1f3ced78d335ec9c2b800d6d5aa3ef8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void activateOptions </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><td>)</td> |
| <td></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>Call createPatternParser. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06">OptionHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a79cba5d2db27cc6537de868018b72d9c"></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"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> |
| <td class="paramname"><em>output</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx_1_1spi.html#ab5abd68f0fb303c6d5f5f7d1ff49b3a6">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="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td> |
| <td class="paramname"><em>pool</em> </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Produces a formatted string as specified by the conversion pattern. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1_layout.html#aefcaf353e4b45b21fc47b7e25410f8ff">Layout</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af5dad3df8eb7d15aaf7863b515405b6b"></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="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getConversionPattern </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the value of the <b>ConversionPattern</b> option. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9f5587f187a5b63ec771af5b7ca2042f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespacelog4cxx_1_1pattern.html#af3e2bcdd3fe2edd7071727492a4efa7d">log4cxx::pattern::PatternMap</a> getFormatSpecifiers </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5796c8d5c4ed8ceae2cb9ebb1db75518"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool ignoresThrowable </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">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string. ">PatternLayout</a> does not handle the throwable contained within <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvents</a>. </p> |
| <p>Thus, it returns <code>true</code>. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1_layout.html#a7d46cce1553abd1ecb65fe6c5761fbd2">Layout</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3c480a3e2a7cd0926354df68221459b1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void setConversionPattern </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> |
| <td class="paramname"><em>conversionPattern</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the <b>ConversionPattern</b> option. </p> |
| <p>This is the string which controls formatting and consists of a mix of literal content and conversion specifiers. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aee5023c29cca9dc68164b22a01cb7c6e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void setOption </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> |
| <td class="paramname"><em>option</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>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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>Set <code>option</code> to <code>value</code>. </p> |
| <p>The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1_pattern_layout.html#af1f3ced78d335ec9c2b800d6d5aa3ef8" title="Call createPatternParser. ">activateOptions</a> is called. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="patternlayout_8h.html">patternlayout.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> |
