<!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: InputStreamReader 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_input_stream_reader.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>InputStreamReader Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::InputStreamReader" --><!-- doxytag: inherits="log4cxx::helpers::Reader" -->
<p><a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> for reading from character streams.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_reader.html">log4cxx::helpers::Reader</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_input_stream_reader-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html#a2ccea09f44998e25591e14d852fd5e60">InputStreamReader</a> (const InputStreamPtr &in)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html" title="Class for reading from character streams.">InputStreamReader</a> that uses the default charset. <a href="#a2ccea09f44998e25591e14d852fd5e60"></a><br/></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_input_stream_reader.html#a834bd0b1cde7f69d8b0eee72af0ee1eb">InputStreamReader</a> (const InputStreamPtr &in, const CharsetDecoderPtr &enc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html" title="Class for reading from character streams.">InputStreamReader</a> that uses the given charset decoder. <a href="#a834bd0b1cde7f69d8b0eee72af0ee1eb"></a><br/></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_input_stream_reader.html#a39d58e0ed5044edcb34bdf9318c42fc5">~InputStreamReader</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_1helpers_1_1_input_stream_reader.html#a021faf2debe747733a05cbae0c838648">close</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the stream. <a href="#a021faf2debe747733a05cbae0c838648"></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_1helpers_1_1_input_stream_reader.html#a43138b11a291e56094482575c1b97595">read</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">Pool</a> &p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html#a7b5502ee1e14732e5c6817372f076497">getEncoding</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> for reading from character streams. </p>
<p>Decorates a byte based <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream.html" title="Abstract class for reading from character streams.">InputStream</a> and provides appropriate conversion to characters. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2ccea09f44998e25591e14d852fd5e60"></a><!-- doxytag: member="log4cxx::helpers::InputStreamReader::InputStreamReader" ref="a2ccea09f44998e25591e14d852fd5e60" args="(const InputStreamPtr &in)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html">InputStreamReader</a> </td>
<td>(</td>
<td class="paramtype">const InputStreamPtr & </td>
<td class="paramname"><em>in</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html" title="Class for reading from character streams.">InputStreamReader</a> that uses the default charset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>The input stream to decorate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a834bd0b1cde7f69d8b0eee72af0ee1eb"></a><!-- doxytag: member="log4cxx::helpers::InputStreamReader::InputStreamReader" ref="a834bd0b1cde7f69d8b0eee72af0ee1eb" args="(const InputStreamPtr &in, const CharsetDecoderPtr &enc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html">InputStreamReader</a> </td>
<td>(</td>
<td class="paramtype">const InputStreamPtr & </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const CharsetDecoderPtr & </td>
<td class="paramname"><em>enc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html" title="Class for reading from character streams.">InputStreamReader</a> that uses the given charset decoder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>The input stream to decorate. </td></tr>
<tr><td class="paramname">enc</td><td>The charset decoder to use for the conversion. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a39d58e0ed5044edcb34bdf9318c42fc5"></a><!-- doxytag: member="log4cxx::helpers::InputStreamReader::~InputStreamReader" ref="a39d58e0ed5044edcb34bdf9318c42fc5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream_reader.html">InputStreamReader</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a021faf2debe747733a05cbae0c838648"></a><!-- doxytag: member="log4cxx::helpers::InputStreamReader::close" ref="a021faf2debe747733a05cbae0c838648" args="(Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">Pool</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The memory pool associated with the reader. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1helpers_1_1_reader.html#ab3f66bab8413777d603554f49a1f26e6">Reader</a>.</p>
</div>
</div>
<a class="anchor" id="a7b5502ee1e14732e5c6817372f076497"></a><!-- doxytag: member="log4cxx::helpers::InputStreamReader::getEncoding" ref="a7b5502ee1e14732e5c6817372f076497" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getEncoding </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The name of the character encoding being used by this stream. </dd></dl>
</div>
</div>
<a class="anchor" id="a43138b11a291e56094482575c1b97595"></a><!-- doxytag: member="log4cxx::helpers::InputStreamReader::read" ref="a43138b11a291e56094482575c1b97595" args="(Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">Pool</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The complete stream contents as a LogString. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The memory pool associated with the reader. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1helpers_1_1_reader.html#a348926111be4f439b0adbcd023b31995">Reader</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="inputstreamreader_8h.html">inputstreamreader.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_input_stream_reader.html">InputStreamReader</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>
