<!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: PropertyResourceBundle 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_property_resource_bundle.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>PropertyResourceBundle Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::PropertyResourceBundle" --><!-- doxytag: inherits="log4cxx::helpers::ResourceBundle" -->
<p><a class="el" href="classlog4cxx_1_1helpers_1_1_property_resource_bundle.html" title="PropertyResourceBundle is a concrete subclass of ResourceBundle that manages resources for a locale u...">PropertyResourceBundle</a> is a concrete subclass of <a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html" title="Resource bundles contain locale-specific objects.">ResourceBundle</a> that manages resources for a locale using a set of static strings from a property file.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html">log4cxx::helpers::ResourceBundle</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_property_resource_bundle-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_property_resource_bundle.html#a5cd6e9ad27e731384eae5668a285ae26">PropertyResourceBundle</a> (InputStreamPtr inStream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a property resource bundle. <a href="#a5cd6e9ad27e731384eae5668a285ae26"></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_property_resource_bundle.html#a553f3d37042b86f3bddabf4ddf8b2475">getString</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a string for the given key from this resource bundle or one of its parents. <a href="#a553f3d37042b86f3bddabf4ddf8b2475"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_properties.html">Properties</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_property_resource_bundle.html#a0aeb5d8aa2b190f8360d442a4946b605">properties</a></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_property_resource_bundle.html" title="PropertyResourceBundle is a concrete subclass of ResourceBundle that manages resources for a locale u...">PropertyResourceBundle</a> is a concrete subclass of <a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html" title="Resource bundles contain locale-specific objects.">ResourceBundle</a> that manages resources for a locale using a set of static strings from a property file. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5cd6e9ad27e731384eae5668a285ae26"></a><!-- doxytag: member="log4cxx::helpers::PropertyResourceBundle::PropertyResourceBundle" ref="a5cd6e9ad27e731384eae5668a285ae26" args="(InputStreamPtr inStream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_property_resource_bundle.html">PropertyResourceBundle</a> </td>
<td>(</td>
<td class="paramtype">InputStreamPtr </td>
<td class="paramname"><em>inStream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a property resource bundle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">inStream</td><td>property file to read from. </td></tr>
</table>
</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_i_o_exception.html" title="Signals that an I/O exception of some sort has occurred.">IOException</a></td><td>if an error occurred when reading from the input stream. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a553f3d37042b86f3bddabf4ddf8b2475"></a><!-- doxytag: member="log4cxx::helpers::PropertyResourceBundle::getString" ref="a553f3d37042b86f3bddabf4ddf8b2475" args="(const LogString &key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a string for the given key from this resource bundle or one of its parents. </p>
<p>Calling this method is equivalent to calling</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the key for the desired string </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the string for the given key </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_missing_resource_exception.html">MissingResourceException</a></td><td>- if no object for the given key can be found </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html#a56de069a4dd928ce13f8b80dfa6ad9e2">ResourceBundle</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0aeb5d8aa2b190f8360d442a4946b605"></a><!-- doxytag: member="log4cxx::helpers::PropertyResourceBundle::properties" ref="a0aeb5d8aa2b190f8360d442a4946b605" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_properties.html">Properties</a> <a class="el" href="classlog4cxx_1_1helpers_1_1_property_resource_bundle.html#a0aeb5d8aa2b190f8360d442a4946b605">properties</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="propertyresourcebundle_8h.html">propertyresourcebundle.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_property_resource_bundle.html">PropertyResourceBundle</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>
