| <!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: XMLLayout 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.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 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_1xml_1_1_x_m_l_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="classlog4cxx_1_1xml_1_1_x_m_l_layout-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">XMLLayout Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The output of the <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. ">XMLLayout</a> consists of a series of log4j:event elements. |
| <a href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for XMLLayout:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classlog4cxx_1_1xml_1_1_x_m_l_layout.png" usemap="#XMLLayout_map" alt=""/> |
| <map id="XMLLayout_map" name="XMLLayout_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:a602a77ed0aadd5ee5fccbb6fb25e6057"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a602a77ed0aadd5ee5fccbb6fb25e6057">XMLLayout</a> ()</td></tr> |
| <tr class="separator:a602a77ed0aadd5ee5fccbb6fb25e6057"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a41d896ff776e8e9094929230bfc5f648"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a41d896ff776e8e9094929230bfc5f648">setLocationInfo</a> (bool locationInfo1)</td></tr> |
| <tr class="memdesc:a41d896ff776e8e9094929230bfc5f648"><td class="mdescLeft"> </td><td class="mdescRight">The <b>LocationInfo</b> option takes a boolean value. <a href="#a41d896ff776e8e9094929230bfc5f648">More...</a><br /></td></tr> |
| <tr class="separator:a41d896ff776e8e9094929230bfc5f648"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad70ffd01a630335c8e0465b04f360db4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#ad70ffd01a630335c8e0465b04f360db4">getLocationInfo</a> () const </td></tr> |
| <tr class="memdesc:ad70ffd01a630335c8e0465b04f360db4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of the <b>LocationInfo</b> option. <a href="#ad70ffd01a630335c8e0465b04f360db4">More...</a><br /></td></tr> |
| <tr class="separator:ad70ffd01a630335c8e0465b04f360db4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3651ce7c1380051806996e07c2ba2d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#aa3651ce7c1380051806996e07c2ba2d9">setProperties</a> (bool flag)</td></tr> |
| <tr class="memdesc:aa3651ce7c1380051806996e07c2ba2d9"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether <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> key-value pairs should be output, default false. <a href="#aa3651ce7c1380051806996e07c2ba2d9">More...</a><br /></td></tr> |
| <tr class="separator:aa3651ce7c1380051806996e07c2ba2d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac9e665bcc71d59dfc2d4891d1140ea8d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#ac9e665bcc71d59dfc2d4891d1140ea8d">getProperties</a> ()</td></tr> |
| <tr class="memdesc:ac9e665bcc71d59dfc2d4891d1140ea8d"><td class="mdescLeft"> </td><td class="mdescRight">Gets whether <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> key-value pairs should be output. <a href="#ac9e665bcc71d59dfc2d4891d1140ea8d">More...</a><br /></td></tr> |
| <tr class="separator:ac9e665bcc71d59dfc2d4891d1140ea8d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a580abdcb8fd42d07eaf679166f77bc34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &)</td></tr> |
| <tr class="memdesc:a580abdcb8fd42d07eaf679166f77bc34"><td class="mdescLeft"> </td><td class="mdescRight">No options to activate. <a href="#a580abdcb8fd42d07eaf679166f77bc34">More...</a><br /></td></tr> |
| <tr class="separator:a580abdcb8fd42d07eaf679166f77bc34"><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_1xml_1_1_x_m_l_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 options. <a href="#aee5023c29cca9dc68164b22a01cb7c6e">More...</a><br /></td></tr> |
| <tr class="separator:aee5023c29cca9dc68164b22a01cb7c6e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1770b2f0ba5e593d62fc798e91b133ca"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a1770b2f0ba5e593d62fc798e91b133ca">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> &p) const </td></tr> |
| <tr class="memdesc:a1770b2f0ba5e593d62fc798e91b133ca"><td class="mdescLeft"> </td><td class="mdescRight">Formats a <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> in conformance with the log4cxx.dtd. <a href="#a1770b2f0ba5e593d62fc798e91b133ca">More...</a><br /></td></tr> |
| <tr class="separator:a1770b2f0ba5e593d62fc798e91b133ca"><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_1xml_1_1_x_m_l_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_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. ">XMLLayout</a> prints and does not ignore exceptions. <a href="#a5796c8d5c4ed8ceae2cb9ebb1db75518">More...</a><br /></td></tr> |
| <tr class="separator:a5796c8d5c4ed8ceae2cb9ebb1db75518"><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:a0ab1bb19059c1de23f8a35cdbc0b6a5c 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#a0ab1bb19059c1de23f8a35cdbc0b6a5c">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2"> </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 * </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> &clazz) const =0</td></tr> |
| <tr class="separator:a04b3422e17b0a882538bbc99833ab9df 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="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>The output of the <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. ">XMLLayout</a> consists of a series of log4j:event elements. </p> |
| <p>It does not output a complete well-formed XML file. The output is designed to be included as an <em>external entity</em> in a separate file to form a correct XML file.</p> |
| <p>For example, if <code>abc</code> is the name of the file where the <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. ">XMLLayout</a> ouput goes, then a well-formed XML file would be:</p> |
| <p><code> <?xml version="1.0" ?></code></p> |
| <p><code><!DOCTYPE log4j:eventSet [<!ENTITY data SYSTEM "abc">]></code></p> |
| <p><code><log4j:eventSet version="1.2" xmlns:log4j="http://jakarta.apache.org/log4j/"> </p><pre class="fragment"> @&data; |
| </pre><p></code></p> |
| <p><code></log4j:eventSet> </code></p> |
| <p>This approach enforces the independence of the <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. ">XMLLayout</a> and the appender where it is embedded. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a602a77ed0aadd5ee5fccbb6fb25e6057"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html">XMLLayout</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a580abdcb8fd42d07eaf679166f77bc34"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">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"></td><td>)</td> |
| <td></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>No options to activate. </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="a1770b2f0ba5e593d62fc798e91b133ca"></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>p</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>Formats a <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> in conformance with the log4cxx.dtd. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1_layout.html#a6bbb942f47dfb852fe11a6963768a046">Layout</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad70ffd01a630335c8e0465b04f360db4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool getLocationInfo </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 current value of the <b>LocationInfo</b> option. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac9e665bcc71d59dfc2d4891d1140ea8d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool getProperties </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></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>Gets whether <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> key-value pairs should be output. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if <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> key-value pairs are output. </dd></dl> |
| |
| </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_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. ">XMLLayout</a> prints and does not ignore exceptions. </p> |
| <p>Hence the return value <code>false</code>. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1_layout.html#a1d057bb4d8c2da05dfa2d61c587f1860">Layout</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a41d896ff776e8e9094929230bfc5f648"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void setLocationInfo </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>locationInfo1</em></td><td>)</td> |
| <td></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>The <b>LocationInfo</b> option takes a boolean value. </p> |
| <p>By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.</p> |
| <p>If you are embedding this layout within a SMTPAppender then make sure to set the <b>LocationInfo</b> option of that appender as well. </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 options. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa3651ce7c1380051806996e07c2ba2d9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void setProperties </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>flag</em></td><td>)</td> |
| <td></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>Sets whether <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> key-value pairs should be output, default false. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">flag</td><td>new value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="xmllayout_8h.html">xmllayout.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> |
