<!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: Layout 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_1_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>Layout Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::Layout" --><!-- doxytag: inherits="log4cxx::spi::OptionHandler,log4cxx::helpers::ObjectImpl" -->
<p>Extend this abstract class to create your own log layout format.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html">log4cxx::spi::OptionHandler</a>, and <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html">DateLayout</a>, <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html">HTMLLayout</a>, <a class="el" href="classlog4cxx_1_1_pattern_layout.html">PatternLayout</a>, <a class="el" href="classlog4cxx_1_1_simple_layout.html">SimpleLayout</a>, and <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html">XMLLayout</a>.</p>
<p><a href="classlog4cxx_1_1_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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#a509ff848be1289bfd6ce0ea98dbf6212">~Layout</a> ()</td></tr>
<tr><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><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><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_layout.html#aefcaf353e4b45b21fc47b7e25410f8ff">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> &pool) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implement this method to create your own layout format. <a href="#aefcaf353e4b45b21fc47b7e25410f8ff"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Returns the content type output by this layout. <a href="#a8d61ef61f2aaf3923ef0a16fc6728dc7"></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_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><td class="mdescLeft"> </td><td class="mdescRight">Append the header for the layout format. <a href="#ad1b07d688e39f3a8d71acec8f6d7b878"></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_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><td class="mdescLeft"> </td><td class="mdescRight">Append the footer for the layout format. <a href="#ae8f7d8f894b39b251cada7674bdfe8d2"></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_1_layout.html#a7d46cce1553abd1ecb65fe6c5761fbd2">ignoresThrowable</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the layout handles the throwable object contained within <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a>, then the layout should return <code>false</code>. <a href="#a7d46cce1553abd1ecb65fe6c5761fbd2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Extend this abstract class to create your own log layout format. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a509ff848be1289bfd6ce0ea98dbf6212"></a><!-- doxytag: member="log4cxx::Layout::~Layout" ref="a509ff848be1289bfd6ce0ea98dbf6212" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1_layout.html">Layout</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0198815940c2715c84b0e04828cf8dfa"></a><!-- doxytag: member="log4cxx::Layout::addRef" ref="a0198815940c2715c84b0e04828cf8dfa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void addRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a0198815940c2715c84b0e04828cf8dfa">ObjectImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ae8f7d8f894b39b251cada7674bdfe8d2"></a><!-- doxytag: member="log4cxx::Layout::appendFooter" ref="ae8f7d8f894b39b251cada7674bdfe8d2" args="(LogString &output, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void appendFooter </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"><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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append the footer for the layout format. </p>
<p>The base class does nothing. </p>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a273cfddfaa1950d22bd104feafb604b3">HTMLLayout</a>.</p>
</div>
</div>
<a class="anchor" id="ad1b07d688e39f3a8d71acec8f6d7b878"></a><!-- doxytag: member="log4cxx::Layout::appendHeader" ref="ad1b07d688e39f3a8d71acec8f6d7b878" args="(LogString &output, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void appendHeader </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"><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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append the header for the layout format. </p>
<p>The base class does nothing. </p>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a396a9f379b832d1b9df431303b0cb93e">HTMLLayout</a>.</p>
</div>
</div>
<a class="anchor" id="aefcaf353e4b45b21fc47b7e25410f8ff"></a><!-- doxytag: member="log4cxx::Layout::format" ref="aefcaf353e4b45b21fc47b7e25410f8ff" args="(LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) const =0" -->
<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>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implement this method to create your own layout format. </p>
<p>Implemented in <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a79cba5d2db27cc6537de868018b72d9c">HTMLLayout</a>, <a class="el" href="classlog4cxx_1_1_pattern_layout.html#a79cba5d2db27cc6537de868018b72d9c">PatternLayout</a>, <a class="el" href="classlog4cxx_1_1_simple_layout.html#a79cba5d2db27cc6537de868018b72d9c">SimpleLayout</a>, <a class="el" href="classlog4cxx_1_1_t_t_c_c_layout.html#a79cba5d2db27cc6537de868018b72d9c">TTCCLayout</a>, and <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a1770b2f0ba5e593d62fc798e91b133ca">XMLLayout</a>.</p>
</div>
</div>
<a class="anchor" id="a8d61ef61f2aaf3923ef0a16fc6728dc7"></a><!-- doxytag: member="log4cxx::Layout::getContentType" ref="a8d61ef61f2aaf3923ef0a16fc6728dc7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getContentType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the content type output by this layout. </p>
<p>The base class returns "text/plain". </p>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a8d61ef61f2aaf3923ef0a16fc6728dc7">HTMLLayout</a>.</p>
</div>
</div>
<a class="anchor" id="a7d46cce1553abd1ecb65fe6c5761fbd2"></a><!-- doxytag: member="log4cxx::Layout::ignoresThrowable" ref="a7d46cce1553abd1ecb65fe6c5761fbd2" args="() const =0" -->
<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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the layout handles the throwable object contained within <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a>, then the layout should return <code>false</code>. </p>
<p>Otherwise, if the layout ignores throwable object, then the layout should return <code>true</code>.</p>
<p>The <a class="el" href="classlog4cxx_1_1_simple_layout.html" title="SimpleLayout consists of the level of the log statement, followed by " - " and then the log...">SimpleLayout</a>, <a class="el" href="classlog4cxx_1_1_t_t_c_c_layout.html" title="TTCC layout format consists of time, thread, logger name and nested diagnostic context information...">TTCCLayout</a>, <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string.">PatternLayout</a> all return <code>true</code>. The <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html">XMLLayout</a> returns <code>false</code>. </p>
<p>Implemented in <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#a5796c8d5c4ed8ceae2cb9ebb1db75518">HTMLLayout</a>, <a class="el" href="classlog4cxx_1_1_pattern_layout.html#a5796c8d5c4ed8ceae2cb9ebb1db75518">PatternLayout</a>, <a class="el" href="classlog4cxx_1_1_simple_layout.html#a750e98e756f29124bf3f9f77a0edfe58">SimpleLayout</a>, <a class="el" href="classlog4cxx_1_1_t_t_c_c_layout.html#a5796c8d5c4ed8ceae2cb9ebb1db75518">TTCCLayout</a>, and <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a5796c8d5c4ed8ceae2cb9ebb1db75518">XMLLayout</a>.</p>
</div>
</div>
<a class="anchor" id="a55c31efee1904916b999395fa4d46a24"></a><!-- doxytag: member="log4cxx::Layout::releaseRef" ref="a55c31efee1904916b999395fa4d46a24" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void releaseRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a55c31efee1904916b999395fa4d46a24">ObjectImpl</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="layout_8h.html">layout.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="classlog4cxx_1_1_layout.html">Layout</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>
