<!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: ResourceBundle 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_resource_bundle.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> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>ResourceBundle Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::ResourceBundle" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>Resource bundles contain locale-specific objects.
<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>Inherited by <a class="el" href="classlog4cxx_1_1helpers_1_1_property_resource_bundle.html">PropertyResourceBundle</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_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">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_resource_bundle.html#a56de069a4dd928ce13f8b80dfa6ad9e2">getString</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key) const =0</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="#a56de069a4dd928ce13f8b80dfa6ad9e2"></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 ResourceBundlePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html#a8bee8c6f803804498f2b63f85b158975">getBundle</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &baseName, const <a class="el" href="classlog4cxx_1_1helpers_1_1_locale.html">Locale</a> &locale)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a resource bundle using the specified base name and locale. <a href="#a8bee8c6f803804498f2b63f85b158975"></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html#a6ab03c98b50c580a40dca8cad76f1e3b">setParent</a> (const ResourceBundlePtr &parent1)</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">ResourceBundlePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html#ae090af77c8e3054551ef69726b2adf1d">parent</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The parent bundle of this bundle. <a href="#ae090af77c8e3054551ef69726b2adf1d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Resource bundles contain locale-specific objects. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8bee8c6f803804498f2b63f85b158975"></a><!-- doxytag: member="log4cxx::helpers::ResourceBundle::getBundle" ref="a8bee8c6f803804498f2b63f85b158975" args="(const LogString &baseName, const Locale &locale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static ResourceBundlePtr getBundle </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>baseName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a resource bundle using the specified base name and locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">baseName</td><td>the base name of the resource bundle, a fully qualified class name or property filename </td></tr>
<tr><td class="paramname">locale</td><td>the locale for which a resource bundle is desired </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a56de069a4dd928ce13f8b80dfa6ad9e2"></a><!-- doxytag: member="log4cxx::helpers::ResourceBundle::getString" ref="a56de069a4dd928ce13f8b80dfa6ad9e2" args="(const LogString &key) const =0" -->
<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> [pure 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>Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_property_resource_bundle.html#a553f3d37042b86f3bddabf4ddf8b2475">PropertyResourceBundle</a>.</p>
</div>
</div>
<a class="anchor" id="a6ab03c98b50c580a40dca8cad76f1e3b"></a><!-- doxytag: member="log4cxx::helpers::ResourceBundle::setParent" ref="a6ab03c98b50c580a40dca8cad76f1e3b" args="(const ResourceBundlePtr &parent1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setParent </td>
<td>(</td>
<td class="paramtype">const ResourceBundlePtr & </td>
<td class="paramname"><em>parent1</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae090af77c8e3054551ef69726b2adf1d"></a><!-- doxytag: member="log4cxx::helpers::ResourceBundle::parent" ref="ae090af77c8e3054551ef69726b2adf1d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ResourceBundlePtr <a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html#ae090af77c8e3054551ef69726b2adf1d">parent</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The parent bundle of this bundle. </p>
<p>The parent bundle is searched by <a class="el" href="classlog4cxx_1_1helpers_1_1_resource_bundle.html#a56de069a4dd928ce13f8b80dfa6ad9e2" title="Gets a string for the given key from this resource bundle or one of its parents.">getString</a> when this bundle does not contain a particular resource. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="resourcebundle_8h.html">resourcebundle.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_resource_bundle.html">ResourceBundle</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>
