<!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: CharsetEncoder 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_1helpers_1_1_charset_encoder.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>CharsetEncoder Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::CharsetEncoder" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>An engine to transform LogStrings into bytes for the specific character set.
<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_1helpers_1_1_charset_encoder-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_1helpers_1_1_charset_encoder.html#a37b138767bbc8049fcf6582344a0eb34">~CharsetEncoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a37b138767bbc8049fcf6582344a0eb34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="log4cxx_8h.html#a5fafb40b34a1643582bd2e830f654ff7">log4cxx_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html#aef808c68e6904f1d7d53db7ae89b4e17">encode</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &in, LogString::const_iterator &iter, <a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> &out)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encodes as many characters from the input string as possible to the output buffer. <a href="#aef808c68e6904f1d7d53db7ae89b4e17"></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_1helpers_1_1_charset_encoder.html#a7b0e029102ad38f4b814c6523aedb53d">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets any internal state. <a href="#a7b0e029102ad38f4b814c6523aedb53d"></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_1helpers_1_1_charset_encoder.html#af87a9bce2173fe6396348af1fc218e70">flush</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> &out)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes the encoder. <a href="#af87a9bce2173fe6396348af1fc218e70"></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 CharsetEncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html#a3efc0424e2c01eba5eca1e30b17b6141">getDefaultEncoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get encoder for default charset. <a href="#a3efc0424e2c01eba5eca1e30b17b6141"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static CharsetEncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html#a62def5992256e0b61493d7adbbf841c0">getEncoder</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &charset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get encoder for specified character set. <a href="#a62def5992256e0b61493d7adbbf841c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static CharsetEncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html#ac0fdc044db02dc7ff34cf7a7a083837d">getUTF8Encoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get encoder for UTF-8. <a href="#ac0fdc044db02dc7ff34cf7a7a083837d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html#a4b904793b6470f8905ff79ee1a2b5a4c">encode</a> (CharsetEncoderPtr &enc, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &src, LogString::const_iterator &iter, <a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> &dst)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encodes a string replacing unmappable characters with escape sequences. <a href="#a4b904793b6470f8905ff79ee1a2b5a4c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html#ae9e960069f22fa622cebd4aede808742">isError</a> (<a class="el" href="log4cxx_8h.html#a5fafb40b34a1643582bd2e830f654ff7">log4cxx_status_t</a> stat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if the return value from encode indicates an unconvertable character. <a href="#ae9e960069f22fa622cebd4aede808742"></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_1helpers_1_1_charset_encoder.html#a517daf9bbe0ee5b2f8dc541935bbaf4e">CharsetEncoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Protected constructor. <a href="#a517daf9bbe0ee5b2f8dc541935bbaf4e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An engine to transform LogStrings into bytes for the specific character set. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a517daf9bbe0ee5b2f8dc541935bbaf4e"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::CharsetEncoder" ref="a517daf9bbe0ee5b2f8dc541935bbaf4e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html">CharsetEncoder</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protected constructor. </p>
</div>
</div>
<a class="anchor" id="a37b138767bbc8049fcf6582344a0eb34"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::~CharsetEncoder" ref="a37b138767bbc8049fcf6582344a0eb34" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html">CharsetEncoder</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4b904793b6470f8905ff79ee1a2b5a4c"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::encode" ref="a4b904793b6470f8905ff79ee1a2b5a4c" args="(CharsetEncoderPtr &enc, const LogString &src, LogString::const_iterator &iter, ByteBuffer &dst)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void encode </td>
<td>(</td>
<td class="paramtype">CharsetEncoderPtr & </td>
<td class="paramname"><em>enc</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>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LogString::const_iterator & </td>
<td class="paramname"><em>iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> & </td>
<td class="paramname"><em>dst</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a string replacing unmappable characters with escape sequences. </p>
</div>
</div>
<a class="anchor" id="aef808c68e6904f1d7d53db7ae89b4e17"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::encode" ref="aef808c68e6904f1d7d53db7ae89b4e17" args="(const LogString &in, LogString::const_iterator &iter, ByteBuffer &out)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="log4cxx_8h.html#a5fafb40b34a1643582bd2e830f654ff7">log4cxx_status_t</a> encode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LogString::const_iterator & </td>
<td class="paramname"><em>iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> & </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes as many characters from the input string as possible to the output buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>input string </td></tr>
<tr><td class="paramname">iter</td><td>position in string to start. </td></tr>
<tr><td class="paramname">out</td><td>output buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>APR_SUCCESS unless a character can not be represented in the encoding. </dd></dl>
</div>
</div>
<a class="anchor" id="af87a9bce2173fe6396348af1fc218e70"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::flush" ref="af87a9bce2173fe6396348af1fc218e70" args="(ByteBuffer &out)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> & </td>
<td class="paramname"><em>out</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flushes the encoder. </p>
</div>
</div>
<a class="anchor" id="a3efc0424e2c01eba5eca1e30b17b6141"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::getDefaultEncoder" ref="a3efc0424e2c01eba5eca1e30b17b6141" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetEncoderPtr getDefaultEncoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get encoder for default charset. </p>
</div>
</div>
<a class="anchor" id="a62def5992256e0b61493d7adbbf841c0"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::getEncoder" ref="a62def5992256e0b61493d7adbbf841c0" args="(const LogString &charset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetEncoderPtr getEncoder </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>charset</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get encoder for specified character set. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">charset</td><td>the following values should be recognized: "US-ASCII", "ISO-8859-1", "UTF-8", "UTF-16BE", "UTF-16LE". </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>encoder. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classlog4cxx_1_1helpers_1_1_illegal_argument_exception.html" title="Thrown to indicate that a method has been passed an illegal or inappropriate argument.">IllegalArgumentException</a></td><td>if encoding is not recognized. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac0fdc044db02dc7ff34cf7a7a083837d"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::getUTF8Encoder" ref="ac0fdc044db02dc7ff34cf7a7a083837d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetEncoderPtr getUTF8Encoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get encoder for UTF-8. </p>
</div>
</div>
<a class="anchor" id="ae9e960069f22fa622cebd4aede808742"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::isError" ref="ae9e960069f22fa622cebd4aede808742" args="(log4cxx_status_t stat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool isError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="log4cxx_8h.html#a5fafb40b34a1643582bd2e830f654ff7">log4cxx_status_t</a> </td>
<td class="paramname"><em>stat</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines if the return value from encode indicates an unconvertable character. </p>
</div>
</div>
<a class="anchor" id="a7b0e029102ad38f4b814c6523aedb53d"></a><!-- doxytag: member="log4cxx::helpers::CharsetEncoder::reset" ref="a7b0e029102ad38f4b814c6523aedb53d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets any internal state. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="charsetencoder_8h.html">charsetencoder.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_1helpers.html">helpers</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_encoder.html">CharsetEncoder</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>
