<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | |
<!-- | |
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. | |
--><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> | |
<title>Apache log4cxx: LineSeparatorPatternConverter Class Reference</title> | |
<link href="doxygen.css" rel="stylesheet" type="text/css"> | |
<link href="tabs.css" rel="stylesheet" type="text/css"> | |
</head><body> | |
<!-- Generated by Doxygen 1.4.6 --> | |
<div class="tabs"> | |
<ul> | |
<li><a href="main.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 id="current"><a href="classes.html"><span>Classes</span></a></li> | |
<li><a href="files.html"><span>Files</span></a></li> | |
</ul></div> | |
<div class="tabs"> | |
<ul> | |
<li><a href="classes.html"><span>Alphabetical List</span></a></li> | |
<li><a href="annotated.html"><span>Class List</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 class="nav"> | |
<a class="el" href="namespacelog4cxx.html">log4cxx</a>::<a class="el" href="namespacelog4cxx_1_1pattern.html">pattern</a>::<a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html">LineSeparatorPatternConverter</a></div> | |
<h1>LineSeparatorPatternConverter Class Reference</h1><!-- doxytag: class="log4cxx::pattern::LineSeparatorPatternConverter" --><!-- doxytag: inherits="log4cxx::pattern::LoggingEventPatternConverter" -->Inherits <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html">LoggingEventPatternConverter</a>. | |
<p> | |
<a href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> | |
Formats a line separator. | |
<p> | |
<table border="0" cellpadding="0" cellspacing="0"> | |
<tr><td></td></tr> | |
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html#e365eeefff6366cf929d51d7ef87255b">format</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> &event, <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &toAppendTo, <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 an event into a string buffer. <a href="#e365eeefff6366cf929d51d7ef87255b"></a><br></td></tr> | |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html#39af815814e5c3011ed62175104853ed">format</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::helpers::ObjectPtr</a> &obj, <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &toAppendTo, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr> | |
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> | |
<tr><td class="memItemLeft" nowrap align="right" valign="top">static PatternConverterPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_line_separator_pattern_converter.html#8ab21ae90307902122f92aca54fed1f4">newInstance</a> (const std::vector< <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> > &options)</td></tr> | |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtains an instance of pattern converter. <a href="#8ab21ae90307902122f92aca54fed1f4"></a><br></td></tr> | |
</table> | |
<hr><h2>Member Function Documentation</h2> | |
<a class="anchor" name="39af815814e5c3011ed62175104853ed"></a><!-- doxytag: member="log4cxx::pattern::LineSeparatorPatternConverter::format" ref="39af815814e5c3011ed62175104853ed" args="(const log4cxx::helpers::ObjectPtr &obj, LogString &toAppendTo, log4cxx::helpers::Pool &p) const " --><p> | |
<table class="mdTable" cellpadding="2" cellspacing="0"> | |
<tr> | |
<td class="mdRow"> | |
<table cellpadding="0" cellspacing="0" border="0"> | |
<tr> | |
<td class="md" nowrap valign="top">void format </td> | |
<td class="md" valign="top">( </td> | |
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::helpers::ObjectPtr</a> & </td> | |
<td class="mdname" nowrap> <em>obj</em>, </td> | |
</tr> | |
<tr> | |
<td class="md" nowrap align="right"></td> | |
<td class="md"></td> | |
<td class="md" nowrap><a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> | |
<td class="mdname" nowrap> <em>toAppendTo</em>, </td> | |
</tr> | |
<tr> | |
<td class="md" nowrap align="right"></td> | |
<td class="md"></td> | |
<td class="md" nowrap><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td> | |
<td class="mdname" nowrap> <em>p</em></td> | |
</tr> | |
<tr> | |
<td class="md"></td> | |
<td class="md">) </td> | |
<td class="md" colspan="2"> const</td> | |
</tr> | |
</table> | |
</td> | |
</tr> | |
</table> | |
<table cellspacing="5" cellpadding="0" border="0"> | |
<tr> | |
<td> | |
| |
</td> | |
<td> | |
<p> | |
<p> | |
Reimplemented from <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#39af815814e5c3011ed62175104853ed">LoggingEventPatternConverter</a>. </td> | |
</tr> | |
</table> | |
<a class="anchor" name="e365eeefff6366cf929d51d7ef87255b"></a><!-- doxytag: member="log4cxx::pattern::LineSeparatorPatternConverter::format" ref="e365eeefff6366cf929d51d7ef87255b" args="(const log4cxx::spi::LoggingEventPtr &event, LogString &toAppendTo, log4cxx::helpers::Pool &p) const " --><p> | |
<table class="mdTable" cellpadding="2" cellspacing="0"> | |
<tr> | |
<td class="mdRow"> | |
<table cellpadding="0" cellspacing="0" border="0"> | |
<tr> | |
<td class="md" nowrap valign="top">void format </td> | |
<td class="md" valign="top">( </td> | |
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> & </td> | |
<td class="mdname" nowrap> <em>event</em>, </td> | |
</tr> | |
<tr> | |
<td class="md" nowrap align="right"></td> | |
<td class="md"></td> | |
<td class="md" nowrap><a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> | |
<td class="mdname" nowrap> <em>toAppendTo</em>, </td> | |
</tr> | |
<tr> | |
<td class="md" nowrap align="right"></td> | |
<td class="md"></td> | |
<td class="md" nowrap><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td> | |
<td class="mdname" nowrap> <em>p</em></td> | |
</tr> | |
<tr> | |
<td class="md"></td> | |
<td class="md">) </td> | |
<td class="md" colspan="2"> const<code> [virtual]</code></td> | |
</tr> | |
</table> | |
</td> | |
</tr> | |
</table> | |
<table cellspacing="5" cellpadding="0" border="0"> | |
<tr> | |
<td> | |
| |
</td> | |
<td> | |
<p> | |
Formats an event into a string buffer. | |
<p> | |
<dl compact><dt><b>Parameters:</b></dt><dd> | |
<table border="0" cellspacing="2" cellpadding="0"> | |
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>event to format, may not be null. </td></tr> | |
<tr><td valign="top"></td><td valign="top"><em>toAppendTo</em> </td><td>string buffer to which the formatted event will be appended. May not be null. </td></tr> | |
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>pool for memory allocations needing during format. </td></tr> | |
</table> | |
</dl> | |
<p> | |
Implements <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#dd24a40209b961a2e87645b000171bd5">LoggingEventPatternConverter</a>. </td> | |
</tr> | |
</table> | |
<a class="anchor" name="8ab21ae90307902122f92aca54fed1f4"></a><!-- doxytag: member="log4cxx::pattern::LineSeparatorPatternConverter::newInstance" ref="8ab21ae90307902122f92aca54fed1f4" args="(const std::vector< LogString > &options)" --><p> | |
<table class="mdTable" cellpadding="2" cellspacing="0"> | |
<tr> | |
<td class="mdRow"> | |
<table cellpadding="0" cellspacing="0" border="0"> | |
<tr> | |
<td class="md" nowrap valign="top">static PatternConverterPtr newInstance </td> | |
<td class="md" valign="top">( </td> | |
<td class="md" nowrap valign="top">const std::vector< <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> > & </td> | |
<td class="mdname1" valign="top" nowrap> <em>options</em> </td> | |
<td class="md" valign="top"> ) </td> | |
<td class="md" nowrap><code> [static]</code></td> | |
</tr> | |
</table> | |
</td> | |
</tr> | |
</table> | |
<table cellspacing="5" cellpadding="0" border="0"> | |
<tr> | |
<td> | |
| |
</td> | |
<td> | |
<p> | |
Obtains an instance of pattern converter. | |
<p> | |
<dl compact><dt><b>Parameters:</b></dt><dd> | |
<table border="0" cellspacing="2" cellpadding="0"> | |
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>options, may be null. </td></tr> | |
</table> | |
</dl> | |
<dl compact><dt><b>Returns:</b></dt><dd>instance of pattern converter. </dd></dl> | |
</td> | |
</tr> | |
</table> | |
<hr>The documentation for this class was generated from the following file:<ul> | |
<li><a class="el" href="lineseparatorpatternconverter_8h.html">lineseparatorpatternconverter.h</a></ul> | |
<!-- | |
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> |