<!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: NameAbbreviator 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_1pattern_1_1_name_abbreviator.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>NameAbbreviator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::pattern::NameAbbreviator" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html" title="NameAbbreviator generates abbreviated logger and class names.">NameAbbreviator</a> generates abbreviated logger and class names.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1pattern_1_1_name_abbreviator-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_1pattern_1_1_name_abbreviator.html#a30b677322e28d20fd92a8af129f6dccd">~NameAbbreviator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html#a11e15d284a72cdb3a1b7bbffed42a2aa">abbreviate</a> (LogString::size_type nameStart, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &buf) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abbreviates a name in a StringBuffer. <a href="#a11e15d284a72cdb3a1b7bbffed42a2aa"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static NameAbbreviatorPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html#af6e9ccbca1c31ee632a49a34bf96efbb">getAbbreviator</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &pattern)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets an abbreviator. <a href="#af6e9ccbca1c31ee632a49a34bf96efbb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static NameAbbreviatorPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html#af102d99fca1bb84f35d5491edef31186">getDefaultAbbreviator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets default abbreviator. <a href="#af102d99fca1bb84f35d5491edef31186"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected 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_1pattern_1_1_name_abbreviator.html#af90f1ab7fd8419634d10fc7189270166">NameAbbreviator</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html" title="NameAbbreviator generates abbreviated logger and class names.">NameAbbreviator</a> generates abbreviated logger and class names. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af90f1ab7fd8419634d10fc7189270166"></a><!-- doxytag: member="log4cxx::pattern::NameAbbreviator::NameAbbreviator" ref="af90f1ab7fd8419634d10fc7189270166" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html">NameAbbreviator</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a30b677322e28d20fd92a8af129f6dccd"></a><!-- doxytag: member="log4cxx::pattern::NameAbbreviator::~NameAbbreviator" ref="a30b677322e28d20fd92a8af129f6dccd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html">NameAbbreviator</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="a11e15d284a72cdb3a1b7bbffed42a2aa"></a><!-- doxytag: member="log4cxx::pattern::NameAbbreviator::abbreviate" ref="a11e15d284a72cdb3a1b7bbffed42a2aa" args="(LogString::size_type nameStart, LogString &buf) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void abbreviate </td>
<td>(</td>
<td class="paramtype">LogString::size_type </td>
<td class="paramname"><em>nameStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Abbreviates a name in a StringBuffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">nameStart</td><td>starting position of name in buf. </td></tr>
<tr><td class="paramname">buf</td><td>buffer, may not be null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af6e9ccbca1c31ee632a49a34bf96efbb"></a><!-- doxytag: member="log4cxx::pattern::NameAbbreviator::getAbbreviator" ref="af6e9ccbca1c31ee632a49a34bf96efbb" args="(const LogString &pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static NameAbbreviatorPtr getAbbreviator </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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets an abbreviator. </p>
<p>For example, "%logger{2}" will output only 2 elements of the logger name, "%logger{1.}" will output only the first character of the non-final elements in the name, "logger(1~.2~} will output the first character of the first element, two characters of the second and subsequent elements and will use a tilde to indicate abbreviated characters.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pattern</td><td>abbreviation pattern. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>abbreviator, will not be null. </dd></dl>
</div>
</div>
<a class="anchor" id="af102d99fca1bb84f35d5491edef31186"></a><!-- doxytag: member="log4cxx::pattern::NameAbbreviator::getDefaultAbbreviator" ref="af102d99fca1bb84f35d5491edef31186" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static NameAbbreviatorPtr getDefaultAbbreviator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets default abbreviator. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>default abbreviator. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="nameabbreviator_8h.html">nameabbreviator.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_1pattern.html">pattern</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1pattern_1_1_name_abbreviator.html">NameAbbreviator</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>
