<!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: CharsetDecoder 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_decoder.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>CharsetDecoder Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::CharsetDecoder" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>An abstract engine to transform a sequences of bytes in a specific charset into a LogString.
<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_decoder-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_decoder.html#a65657b3d303c69d05de066b0529cec02">~CharsetDecoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a65657b3d303c69d05de066b0529cec02"></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_decoder.html#a284406bd29c41967c1d07411617187f0">decode</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> &in, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &out)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decodes as many bytes as possible from the given input buffer, writing the results to the given output string. <a href="#a284406bd29c41967c1d07411617187f0"></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 CharsetDecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_decoder.html#a21f47780c07b224b492023f717de556a">getDefaultDecoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get decoder for default charset. <a href="#a21f47780c07b224b492023f717de556a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static CharsetDecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_decoder.html#a86efca8d08e6c59afdf349c0219e3873">getDecoder</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &charset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get decoder for specified character set. <a href="#a86efca8d08e6c59afdf349c0219e3873"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static CharsetDecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_decoder.html#ad54387499dd65b093d8b316fa2711e69">getUTF8Decoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get decoder for UTF-8. <a href="#ad54387499dd65b093d8b316fa2711e69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static CharsetDecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_decoder.html#a0638fe0b7a899f339908b4bf90560956">getISOLatinDecoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get decoder for ISO-8859-1. <a href="#a0638fe0b7a899f339908b4bf90560956"></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_decoder.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">Determins if status value indicates an invalid byte sequence. <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_decoder.html#a809e9be4c8b780ce60826f716c40a80c">CharsetDecoder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Protected constructor. <a href="#a809e9be4c8b780ce60826f716c40a80c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An abstract engine to transform a sequences of bytes in a specific charset into a LogString. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a809e9be4c8b780ce60826f716c40a80c"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::CharsetDecoder" ref="a809e9be4c8b780ce60826f716c40a80c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_charset_decoder.html">CharsetDecoder</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="a65657b3d303c69d05de066b0529cec02"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::~CharsetDecoder" ref="a65657b3d303c69d05de066b0529cec02" 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_decoder.html">CharsetDecoder</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="a284406bd29c41967c1d07411617187f0"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::decode" ref="a284406bd29c41967c1d07411617187f0" args="(ByteBuffer &in, LogString &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> decode </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>in</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>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes as many bytes as possible from the given input buffer, writing the results to the given output string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>input buffer. </td></tr>
<tr><td class="paramname">out</td><td>output string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>APR_SUCCESS if not encoding errors were found. </dd></dl>
</div>
</div>
<a class="anchor" id="a86efca8d08e6c59afdf349c0219e3873"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::getDecoder" ref="a86efca8d08e6c59afdf349c0219e3873" args="(const LogString &charset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetDecoderPtr getDecoder </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 decoder 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>decoder </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 charset is not recognized. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a21f47780c07b224b492023f717de556a"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::getDefaultDecoder" ref="a21f47780c07b224b492023f717de556a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetDecoderPtr getDefaultDecoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get decoder for default charset. </p>
</div>
</div>
<a class="anchor" id="a0638fe0b7a899f339908b4bf90560956"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::getISOLatinDecoder" ref="a0638fe0b7a899f339908b4bf90560956" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetDecoderPtr getISOLatinDecoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get decoder for ISO-8859-1. </p>
</div>
</div>
<a class="anchor" id="ad54387499dd65b093d8b316fa2711e69"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::getUTF8Decoder" ref="ad54387499dd65b093d8b316fa2711e69" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static CharsetDecoderPtr getUTF8Decoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get decoder for UTF-8. </p>
</div>
</div>
<a class="anchor" id="ae9e960069f22fa622cebd4aede808742"></a><!-- doxytag: member="log4cxx::helpers::CharsetDecoder::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>Determins if status value indicates an invalid byte sequence. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="charsetdecoder_8h.html">charsetdecoder.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_decoder.html">CharsetDecoder</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>
