📄 messageresources.html
字号:
<!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" xml:lang="null" lang="null"><head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>MessageResources xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/net/sf/navigator/util/MessageResources.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * $Header: /cvsroot/struts-menu/navigator/src/java/net/sf/navigator/util/MessageResources.java,v 1.2 2006/05/12 19:52:25 mraible Exp $</em>
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 1.2 $</em>
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2006/05/12 19:52:25 $</em>
<a name="5" href="#5">5</a> <em class="comment"> *</em>
<a name="6" href="#6">6</a> <em class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</em>
<a name="7" href="#7">7</a> <em class="comment"> * </em>
<a name="8" href="#8">8</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a> <em class="comment"> * </em>
<a name="12" href="#12">12</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a> <em class="comment"> * </em>
<a name="14" href="#14">14</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a> <em class="comment"> * limitations under the License.</em>
<a name="19" href="#19">19</a> <em class="comment"> */</em>
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong>package</strong> net.sf.navigator.util;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <strong>import</strong> org.apache.commons.logging.Log;
<a name="24" href="#24">24</a> <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a> <strong>import</strong> java.io.Serializable;
<a name="27" href="#27">27</a> <strong>import</strong> java.text.MessageFormat;
<a name="28" href="#28">28</a> <strong>import</strong> java.util.HashMap;
<a name="29" href="#29">29</a> <strong>import</strong> java.util.Locale;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <em>/**</em>
<a name="32" href="#32">32</a> <em> * General purpose abstract class that describes an API for retrieving</em>
<a name="33" href="#33">33</a> <em> * Locale-sensitive messages from underlying resource locations of an</em>
<a name="34" href="#34">34</a> <em> * unspecified design, and optionally utilizing the <code>MessageFormat</code></em>
<a name="35" href="#35">35</a> <em> * class to produce internationalized messages with parametric replacement.</em>
<a name="36" href="#36">36</a> <em> * <p></em>
<a name="37" href="#37">37</a> <em> * Calls to <code>getMessage()</code> variants without a <code>Locale</code></em>
<a name="38" href="#38">38</a> <em> * argument are presumed to be requesting a message string in the default</em>
<a name="39" href="#39">39</a> <em> * <code>Locale</code> for this JVM.</em>
<a name="40" href="#40">40</a> <em> * <p></em>
<a name="41" href="#41">41</a> <em> * Calls to <code>getMessage()</code> with an unknown key, or an unknown</em>
<a name="42" href="#42">42</a> <em> * <code>Locale</code> will return <code>null</code> if the</em>
<a name="43" href="#43">43</a> <em> * <code>returnNull</code> property is set to <code>true</code>. Otherwise,</em>
<a name="44" href="#44">44</a> <em> * a suitable error message will be returned instead.</em>
<a name="45" href="#45">45</a> <em> * <p></em>
<a name="46" href="#46">46</a> <em> * <strong>IMPLEMENTATION NOTE</strong> - Classes that extend this class</em>
<a name="47" href="#47">47</a> <em> * must be Serializable so that instances may be used in distributable</em>
<a name="48" href="#48">48</a> <em> * application server environments.</em>
<a name="49" href="#49">49</a> <em> *</em>
<a name="50" href="#50">50</a> <em> * @version $Revision: 1.2 $ $Date: 2006/05/12 19:52:25 $</em>
<a name="51" href="#51">51</a> <em> */</em>
<a name="52" href="#52">52</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../net/sf/navigator/util/MessageResources.html">MessageResources</a> implements Serializable {
<a name="53" href="#53">53</a>
<a name="54" href="#54">54</a> <em class="comment">// ------------------------------------------------------------- Properties</em>
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <em>/**</em>
<a name="57" href="#57">57</a> <em> * Commons Logging instance.</em>
<a name="58" href="#58">58</a> <em> */</em>
<a name="59" href="#59">59</a> <strong>protected</strong> <strong>static</strong> Log log = LogFactory.getLog(MessageResources.<strong>class</strong>);
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <em>/**</em>
<a name="62" href="#62">62</a> <em> * The configuration parameter used to initialize this MessageResources.</em>
<a name="63" href="#63">63</a> <em> */</em>
<a name="64" href="#64">64</a> <strong>protected</strong> String config = <strong>null</strong>;
<a name="65" href="#65">65</a>
<a name="66" href="#66">66</a> <em>/**</em>
<a name="67" href="#67">67</a> <em> * The configuration parameter used to initialize this MessageResources.</em>
<a name="68" href="#68">68</a> <em> * @return parameter used to initialize this MessageResources</em>
<a name="69" href="#69">69</a> <em> */</em>
<a name="70" href="#70">70</a> <strong>public</strong> String getConfig() {
<a name="71" href="#71">71</a> <strong>return</strong> (<strong>this</strong>.config);
<a name="72" href="#72">72</a> }
<a name="73" href="#73">73</a>
<a name="74" href="#74">74</a> <em>/**</em>
<a name="75" href="#75">75</a> <em> * The default Locale for our environment.</em>
<a name="76" href="#76">76</a> <em> */</em>
<a name="77" href="#77">77</a> <strong>protected</strong> Locale defaultLocale = Locale.getDefault();
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em>/**</em>
<a name="80" href="#80">80</a> <em> * The <code>MessageResourcesFactory</code> that created this instance.</em>
<a name="81" href="#81">81</a> <em> */</em>
<a name="82" href="#82">82</a> <strong>protected</strong> <a href="../../../../net/sf/navigator/util/MessageResourcesFactory.html">MessageResourcesFactory</a> factory = <strong>null</strong>;
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <em>/**</em>
<a name="85" href="#85">85</a> <em> * The <code>MessageResourcesFactory</code> that created this instance.</em>
<a name="86" href="#86">86</a> <em> * @return <code>MessageResourcesFactory</code> that created instance</em>
<a name="87" href="#87">87</a> <em> */</em>
<a name="88" href="#88">88</a> <strong>public</strong> <a href="../../../../net/sf/navigator/util/MessageResourcesFactory.html">MessageResourcesFactory</a> getFactory() {
<a name="89" href="#89">89</a> <strong>return</strong> (<strong>this</strong>.factory);
<a name="90" href="#90">90</a> }
<a name="91" href="#91">91</a>
<a name="92" href="#92">92</a> <em>/**</em>
<a name="93" href="#93">93</a> <em> * The set of previously created MessageFormat objects, keyed by the</em>
<a name="94" href="#94">94</a> <em> * key computed in <code>messageKey()</code>.</em>
<a name="95" href="#95">95</a> <em> */</em>
<a name="96" href="#96">96</a> <strong>protected</strong> HashMap formats = <strong>new</strong> HashMap();
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <em>/**</em>
<a name="99" href="#99">99</a> <em> * Indicate is a <code>null</code> is returned instead of an error message string</em>
<a name="100" href="#100">100</a> <em> * when an unknown Locale or key is requested.</em>
<a name="101" href="#101">101</a> <em> */</em>
<a name="102" href="#102">102</a> <strong>protected</strong> <strong>boolean</strong> returnNull = false;
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> <em>/**</em>
<a name="105" href="#105">105</a> <em> * Indicates that a <code>null</code> is returned instead of an error message string</em>
<a name="106" href="#106">106</a> <em> * if an unknown Locale or key is requested.</em>
<a name="107" href="#107">107</a> <em> * @return true if null is returned if unknown key or locale is requested</em>
<a name="108" href="#108">108</a> <em> */</em>
<a name="109" href="#109">109</a> <strong>public</strong> <strong>boolean</strong> getReturnNull() {
<a name="110" href="#110">110</a> <strong>return</strong> (<strong>this</strong>.<strong>return</strong>Null);
<a name="111" href="#111">111</a> }
<a name="112" href="#112">112</a>
<a name="113" href="#113">113</a> <em>/**</em>
<a name="114" href="#114">114</a> <em> * Indicates that a <code>null</code> is returned instead of an error message string</em>
<a name="115" href="#115">115</a> <em> * if an unknown Locale or key is requested.</em>
<a name="116" href="#116">116</a> <em> * @param returnNull true Indicates that a <code>null</code> is returned</em>
<a name="117" href="#117">117</a> <em> * if an unknown Locale or key is requested.</em>
<a name="118" href="#118">118</a> <em> */</em>
<a name="119" href="#119">119</a> <strong>public</strong> <strong>void</strong> setReturnNull(<strong>boolean</strong> returnNull) {
<a name="120" href="#120">120</a> <strong>this</strong>.returnNull = returnNull;
<a name="121" href="#121">121</a> }
<a name="122" href="#122">122</a>
<a name="123" href="#123">123</a> <em class="comment">// ----------------------------------------------------------- Constructors</em>
<a name="124" href="#124">124</a>
<a name="125" href="#125">125</a> <em>/**</em>
<a name="126" href="#126">126</a> <em> * Construct a new MessageResources according to the specified parameters.</em>
<a name="127" href="#127">127</a> <em> *</em>
<a name="128" href="#128">128</a> <em> * @param factory The MessageResourcesFactory that created us</em>
<a name="129" href="#129">129</a> <em> * @param config The configuration parameter for this MessageResources</em>
<a name="130" href="#130">130</a> <em> */</em>
<a name="131" href="#131">131</a> <strong>public</strong> <a href="../../../../net/sf/navigator/util/MessageResources.html">MessageResources</a>(<a href="../../../../net/sf/navigator/util/MessageResourcesFactory.html">MessageResourcesFactory</a> factory, String config) {
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <strong>this</strong>(factory, config, false);
<a name="134" href="#134">134</a>
<a name="135" href="#135">135</a> }
<a name="136" href="#136">136</a>
<a name="137" href="#137">137</a> <em>/**</em>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -