<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: XMLLayout Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1xml_1_1_x_m_l_layout.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XMLLayout Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::xml::XMLLayout" --><!-- doxytag: inherits="log4cxx::Layout" -->
<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="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1_layout.html">log4cxx::Layout</a>.</p>
<p><a href="classlog4cxx_1_1xml_1_1_x_m_l_layout-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </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><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><td class="mdescLeft"> </td><td class="mdescRight">The <b>LocationInfo</b> option takes a boolean value. <a href="#a41d896ff776e8e9094929230bfc5f648"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of the <b>LocationInfo</b> option. <a href="#ad70ffd01a630335c8e0465b04f360db4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#aa3651ce7c1380051806996e07c2ba2d9">setProperties</a> (bool flag)</td></tr>
<tr><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_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><td class="mdescLeft"> </td><td class="mdescRight">No options to activate. <a href="#a580abdcb8fd42d07eaf679166f77bc34"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Set options. <a href="#aee5023c29cca9dc68164b22a01cb7c6e"></a><br/></td></tr>
<tr><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="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr>
<tr><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"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>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/"></code></p>
<p><code> &data;</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><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a602a77ed0aadd5ee5fccbb6fb25e6057"></a><!-- doxytag: member="log4cxx::xml::XMLLayout::XMLLayout" ref="a602a77ed0aadd5ee5fccbb6fb25e6057" args="()" -->
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a580abdcb8fd42d07eaf679166f77bc34"></a><!-- doxytag: member="log4cxx::xml::XMLLayout::activateOptions" ref="a580abdcb8fd42d07eaf679166f77bc34" args="(log4cxx::helpers::Pool &)" -->
<div class="memitem">
<div class="memproto">
<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><code> [inline, virtual]</code></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><!-- doxytag: member="log4cxx::xml::XMLLayout::format" ref="a1770b2f0ba5e593d62fc798e91b133ca" args="(LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<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="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">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<code> [virtual]</code></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#aefcaf353e4b45b21fc47b7e25410f8ff">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="ad70ffd01a630335c8e0465b04f360db4"></a><!-- doxytag: member="log4cxx::xml::XMLLayout::getLocationInfo" ref="ad70ffd01a630335c8e0465b04f360db4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getLocationInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></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><!-- doxytag: member="log4cxx::xml::XMLLayout::getProperties" ref="ac9e665bcc71d59dfc2d4891d1140ea8d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getProperties </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></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="return"><dt><b>Returns:</b></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><!-- doxytag: member="log4cxx::xml::XMLLayout::ignoresThrowable" ref="a5796c8d5c4ed8ceae2cb9ebb1db75518" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ignoresThrowable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></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#a7d46cce1553abd1ecb65fe6c5761fbd2">Layout</a>.</p>
</div>
</div>
<a class="anchor" id="a41d896ff776e8e9094929230bfc5f648"></a><!-- doxytag: member="log4cxx::xml::XMLLayout::setLocationInfo" ref="a41d896ff776e8e9094929230bfc5f648" args="(bool locationInfo1)" -->
<div class="memitem">
<div class="memproto">
<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><code> [inline]</code></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><!-- doxytag: member="log4cxx::xml::XMLLayout::setOption" ref="aee5023c29cca9dc68164b22a01cb7c6e" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<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><code> [virtual]</code></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><!-- doxytag: member="log4cxx::xml::XMLLayout::setProperties" ref="aa3651ce7c1380051806996e07c2ba2d9" args="(bool flag)" -->
<div class="memitem">
<div class="memproto">
<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><code> [inline]</code></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><dt><b>Parameters:</b></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>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1xml.html">xml</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html">XMLLayout</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
