source: release-kits/lirk3/bin/ant-installer/web/java2html/antinstaller/org/tp23/antinstaller/ResourceBundleHelper.java.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3

File size: 10.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
2<HTML>
3<HEAD>
4<LINK REL=STYLESHEET TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
5<META NAME="GENERATOR" CONTENT="Java2HTML Version 1.4">
6<TITLE>org.tp23.antinstaller.ResourceBundleHelper (Java2HTML)</TITLE>
7</HEAD>
8<BODY><TABLE id="Header" border="0" cellpadding="0" cellspacing="0" width="100%">
9<tr>
10<td colspan="2" width="33%">&nbsp;</td>
11<td align="center" colspan="2" width="33%">
12<font size="4" class="ClassName">ResourceBundleHelper.java</font>
13</td>
14<td align="right" colspan="2" width="33%">&nbsp;</td>
15</tr>
16</TABLE>
17<pre CLASS="Classes">
18<FONT CLASS="LN">1 </FONT><A NAME="1"></A><FONT CLASS="MultiLineComment">/*
19<FONT CLASS="LN">2 </FONT><A NAME="2"></A> * Licensed under the Apache License, Version 2.0 (the "License");
20<FONT CLASS="LN">3 </FONT><A NAME="3"></A> * you may not use this file except in compliance with the License.
21<FONT CLASS="LN">4 </FONT><A NAME="4"></A> * You may obtain a copy of the License at
22<FONT CLASS="LN">5 </FONT><A NAME="5"></A> *
23<FONT CLASS="LN">6 </FONT><A NAME="6"></A> * http://www.apache.org/licenses/LICENSE-2.0
24<FONT CLASS="LN">7 </FONT><A NAME="7"></A> *
25<FONT CLASS="LN">8 </FONT><A NAME="8"></A> * Unless required by applicable law or agreed to in writing, software
26<FONT CLASS="LN">9 </FONT><A NAME="9"></A> * distributed under the License is distributed on an "AS IS" BASIS,
27<FONT CLASS="LN">10</FONT><A NAME="10"></A> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
28<FONT CLASS="LN">11</FONT><A NAME="11"></A> * See the License for the specific language governing permissions and
29<FONT CLASS="LN">12</FONT><A NAME="12"></A> * limitations under the License.
30<FONT CLASS="LN">13</FONT><A NAME="13"></A> */</FONT>
31<FONT CLASS="LN">14</FONT><A NAME="14"></A><FONT CLASS="Package">package</FONT> <A HREF="../../../org.tp23.antinstaller.index.html" target="packageFrame">org.tp23.antinstaller</A>;
32<FONT CLASS="LN">15</FONT><A NAME="15"></A>
33<FONT CLASS="LN">16</FONT><A NAME="16"></A><FONT CLASS="Import">import</FONT> java.text.MessageFormat;
34<FONT CLASS="LN">17</FONT><A NAME="17"></A><FONT CLASS="Import">import</FONT> java.util.MissingResourceException;
35<FONT CLASS="LN">18</FONT><A NAME="18"></A><FONT CLASS="Import">import</FONT> java.util.ResourceBundle;
36<FONT CLASS="LN">19</FONT><A NAME="19"></A>
37<FONT CLASS="LN">20</FONT><A NAME="20"></A><FONT CLASS="FormalComment">/**
38<FONT CLASS="LN">21</FONT><A NAME="21"></A> * Helper class that will catch missing bundle entries and handle formatting
39<FONT CLASS="LN">22</FONT><A NAME="22"></A> * of message strings
40<FONT CLASS="LN">23</FONT><A NAME="23"></A> *
41<FONT CLASS="LN">24</FONT><A NAME="24"></A> * @author mwilson
42<FONT CLASS="LN">25</FONT><A NAME="25"></A> * @version $Id
43<FONT CLASS="LN">26</FONT><A NAME="26"></A> * @since 0.7.4 patch 7
44<FONT CLASS="LN">27</FONT><A NAME="27"></A> */</FONT>
45<FONT CLASS="LN">28</FONT><A NAME="28"></A><FONT CLASS="Public">public</FONT> <FONT CLASS="Class">class</FONT> ResourceBundleHelper
46<FONT CLASS="LN">29</FONT><A NAME="29"></A>{
47<FONT CLASS="LN">30</FONT><A NAME="30"></A> <FONT CLASS="Private">private</FONT> String bundleName;
48<FONT CLASS="LN">31</FONT><A NAME="31"></A> <FONT CLASS="Private">private</FONT> ResourceBundle resourceBundle;
49<FONT CLASS="LN">32</FONT><A NAME="32"></A>
50<FONT CLASS="LN">33</FONT><A NAME="33"></A> <FONT CLASS="Private">private</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Final">final</FONT> Object[] EMPTY_OBJ_ARRAY = <FONT CLASS="New">new</FONT> Object[<FONT CLASS="IntegerLiteral">0</FONT>];
51<FONT CLASS="LN">34</FONT><A NAME="34"></A> <FONT CLASS="Private">private</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Final">final</FONT> String EMPTY_STRING = <FONT CLASS="StringLiteral">""</FONT>;
52<FONT CLASS="LN">35</FONT><A NAME="35"></A>
53<FONT CLASS="LN">36</FONT><A NAME="36"></A> <FONT CLASS="Public">public</FONT> ResourceBundleHelper( <FONT CLASS="Final">final</FONT> String bundleName )
54<FONT CLASS="LN">37</FONT><A NAME="37"></A> {
55<FONT CLASS="LN">38</FONT><A NAME="38"></A> <FONT CLASS="This">this</FONT>.bundleName = bundleName;
56<FONT CLASS="LN">39</FONT><A NAME="39"></A> resourceBundle = ResourceBundle.getBundle( bundleName );
57<FONT CLASS="LN">40</FONT><A NAME="40"></A> }
58<FONT CLASS="LN">41</FONT><A NAME="41"></A>
59<FONT CLASS="LN">42</FONT><A NAME="42"></A> <FONT CLASS="Public">public</FONT> String getMessage( <FONT CLASS="Final">final</FONT> String key )
60<FONT CLASS="LN">43</FONT><A NAME="43"></A> {
61<FONT CLASS="LN">44</FONT><A NAME="44"></A> <FONT CLASS="Return">return</FONT> getMessage( key, EMPTY_OBJ_ARRAY );
62<FONT CLASS="LN">45</FONT><A NAME="45"></A> }
63<FONT CLASS="LN">46</FONT><A NAME="46"></A>
64<FONT CLASS="LN">47</FONT><A NAME="47"></A> <FONT CLASS="Public">public</FONT> String getMessage( <FONT CLASS="Final">final</FONT> String key, <FONT CLASS="Final">final</FONT> Object obj )
65<FONT CLASS="LN">48</FONT><A NAME="48"></A> {
66<FONT CLASS="LN">49</FONT><A NAME="49"></A> <FONT CLASS="Return">return</FONT> getMessage( key, <FONT CLASS="New">new</FONT> Object[] { obj } );
67<FONT CLASS="LN">50</FONT><A NAME="50"></A> }
68<FONT CLASS="LN">51</FONT><A NAME="51"></A>
69<FONT CLASS="LN">52</FONT><A NAME="52"></A> <FONT CLASS="FormalComment">/**
70<FONT CLASS="LN">53</FONT><A NAME="53"></A> * Return a formatted message string.
71<FONT CLASS="LN">54</FONT><A NAME="54"></A> * @param key resource bundle key
72<FONT CLASS="LN">55</FONT><A NAME="55"></A> * @param objArray array of objects that will be used with formatting
73<FONT CLASS="LN">56</FONT><A NAME="56"></A> * string
74<FONT CLASS="LN">57</FONT><A NAME="57"></A> * @return formatted string or error message if the resource bundle
75<FONT CLASS="LN">58</FONT><A NAME="58"></A> * entry is missing
76<FONT CLASS="LN">59</FONT><A NAME="59"></A> */</FONT>
77<FONT CLASS="LN">60</FONT><A NAME="60"></A> <FONT CLASS="Public">public</FONT> String getMessage( String key, Object objArray[] )
78<FONT CLASS="LN">61</FONT><A NAME="61"></A> {
79<FONT CLASS="LN">62</FONT><A NAME="62"></A> String message;
80<FONT CLASS="LN">63</FONT><A NAME="63"></A>
81<FONT CLASS="LN">64</FONT><A NAME="64"></A> <FONT CLASS="SingleLineComment">//Replace null values with empty strings - safer
82<FONT CLASS="LN">65</FONT><A NAME="65"></A></FONT> <FONT CLASS="For">for</FONT>( <FONT CLASS="Int">int</FONT> i = <FONT CLASS="IntegerLiteral">0</FONT>; i &lt; objArray.length; i++ )
83<FONT CLASS="LN">66</FONT><A NAME="66"></A> {
84<FONT CLASS="LN">67</FONT><A NAME="67"></A> <FONT CLASS="If">if</FONT>( objArray[i] == <FONT CLASS="Null">null</FONT> )
85<FONT CLASS="LN">68</FONT><A NAME="68"></A> {
86<FONT CLASS="LN">69</FONT><A NAME="69"></A> objArray[i] = EMPTY_STRING;
87<FONT CLASS="LN">70</FONT><A NAME="70"></A> }
88<FONT CLASS="LN">71</FONT><A NAME="71"></A> }
89<FONT CLASS="LN">72</FONT><A NAME="72"></A>
90<FONT CLASS="LN">73</FONT><A NAME="73"></A> String formatStr = <FONT CLASS="Null">null</FONT>;
91<FONT CLASS="LN">74</FONT><A NAME="74"></A>
92<FONT CLASS="LN">75</FONT><A NAME="75"></A> <FONT CLASS="Try">try</FONT>
93<FONT CLASS="LN">76</FONT><A NAME="76"></A> {
94<FONT CLASS="LN">77</FONT><A NAME="77"></A> formatStr = resourceBundle.getString( key );
95<FONT CLASS="LN">78</FONT><A NAME="78"></A> }
96<FONT CLASS="LN">79</FONT><A NAME="79"></A> <FONT CLASS="Catch">catch</FONT>( MissingResourceException missingResExc )
97<FONT CLASS="LN">80</FONT><A NAME="80"></A> {
98<FONT CLASS="LN">81</FONT><A NAME="81"></A> <FONT CLASS="SingleLineComment">//Handle missing resource below...
99<FONT CLASS="LN">82</FONT><A NAME="82"></A></FONT> }
100<FONT CLASS="LN">83</FONT><A NAME="83"></A>
101<FONT CLASS="LN">84</FONT><A NAME="84"></A> <FONT CLASS="If">if</FONT>( formatStr == <FONT CLASS="Null">null</FONT> )
102<FONT CLASS="LN">85</FONT><A NAME="85"></A> {
103<FONT CLASS="LN">86</FONT><A NAME="86"></A> StringBuffer strBuffer = <FONT CLASS="New">new</FONT> StringBuffer( <FONT CLASS="StringLiteral">"Message entry with key "</FONT> );
104<FONT CLASS="LN">87</FONT><A NAME="87"></A> strBuffer.append( key );
105<FONT CLASS="LN">88</FONT><A NAME="88"></A> strBuffer.append( <FONT CLASS="StringLiteral">" is missing from resource bundle "</FONT> );
106<FONT CLASS="LN">89</FONT><A NAME="89"></A> strBuffer.append( bundleName );
107<FONT CLASS="LN">90</FONT><A NAME="90"></A> strBuffer.append( <FONT CLASS="StringLiteral">"\n"</FONT> );
108<FONT CLASS="LN">91</FONT><A NAME="91"></A> strBuffer.append( bundleName );
109<FONT CLASS="LN">92</FONT><A NAME="92"></A> strBuffer.append( <FONT CLASS="StringLiteral">":: "</FONT> );
110<FONT CLASS="LN">93</FONT><A NAME="93"></A> strBuffer.append( key );
111<FONT CLASS="LN">94</FONT><A NAME="94"></A> <FONT CLASS="For">for</FONT>( <FONT CLASS="Int">int</FONT> i = <FONT CLASS="IntegerLiteral">0</FONT>; i &lt; objArray.length; i++ )
112<FONT CLASS="LN">95</FONT><A NAME="95"></A> {
113<FONT CLASS="LN">96</FONT><A NAME="96"></A> strBuffer.append( <FONT CLASS="StringLiteral">" "</FONT> );
114<FONT CLASS="LN">97</FONT><A NAME="97"></A> strBuffer.append( objArray[i].toString() );
115<FONT CLASS="LN">98</FONT><A NAME="98"></A> }
116<FONT CLASS="LN">99</FONT><A NAME="99"></A>
117<FONT CLASS="LN">00</FONT><A NAME="100"></A> message = strBuffer.toString();
118<FONT CLASS="LN">01</FONT><A NAME="101"></A> }
119<FONT CLASS="LN">02</FONT><A NAME="102"></A> <FONT CLASS="Else">else</FONT>
120<FONT CLASS="LN">03</FONT><A NAME="103"></A> {
121<FONT CLASS="LN">04</FONT><A NAME="104"></A> MessageFormat msgformat = <FONT CLASS="New">new</FONT> MessageFormat( formatStr );
122<FONT CLASS="LN">05</FONT><A NAME="105"></A> message = msgformat.format( ( (Object) ( objArray ) ) );
123<FONT CLASS="LN">06</FONT><A NAME="106"></A> }
124<FONT CLASS="LN">07</FONT><A NAME="107"></A>
125<FONT CLASS="LN">08</FONT><A NAME="108"></A> <FONT CLASS="Return">return</FONT> message;
126<FONT CLASS="LN">09</FONT><A NAME="109"></A> }
127<FONT CLASS="LN">10</FONT><A NAME="110"></A>
128<FONT CLASS="LN">11</FONT><A NAME="111"></A>}
129<FONT CLASS="LN">12</FONT><A NAME="112"></A></pre>
130</BODY>
131</HTML>
Note: See TracBrowser for help on using the repository browser.