KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > swixml > Localizer


1 /*--
2  $Id: Localizer.java,v 1.2 2004/08/20 05:59:57 wolfpaulus Exp $
3
4  Copyright (C) 2003-2004 Wolf Paulus.
5  All rights reserved.
6
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions
9  are met:
10
11  1. Redistributions of source code must retain the above copyright
12  notice, this list of conditions, and the following disclaimer.
13
14  2. Redistributions in binary form must reproduce the above copyright
15  notice, this list of conditions, and the disclaimer that follows
16  these conditions in the documentation and/or other materials provided
17  with the distribution.
18
19  3. The end-user documentation included with the redistribution,
20  if any, must include the following acknowledgment:
21         "This product includes software developed by the
22          SWIXML Project (http://www.swixml.org/)."
23  Alternately, this acknowledgment may appear in the software itself,
24  if and wherever such third-party acknowledgments normally appear.
25
26  4. The name "Swixml" must not be used to endorse or promote products
27  derived from this software without prior written permission. For
28  written permission, please contact <info_AT_swixml_DOT_org>
29
30  5. Products derived from this software may not be called "Swixml",
31  nor may "Swixml" appear in their name, without prior written
32  permission from the Swixml Project Management.
33
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  DISCLAIMED. IN NO EVENT SHALL THE SWIXML PROJECT OR ITS
38  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
41  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
42  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
44  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
45  SUCH DAMAGE.
46  ====================================================================
47
48  This software consists of voluntary contributions made by many
49  individuals on behalf of the Swixml Project and was originally
50  created by Wolf Paulus <wolf_AT_swixml_DOT_org>. For more information
51  on the Swixml Project, please see <http://www.swixml.org/>.
52 */
53
54 package org.swixml;
55
56 import java.util.Locale JavaDoc;
57 import java.util.MissingResourceException JavaDoc;
58 import java.util.ResourceBundle JavaDoc;
59
60 /**
61  * The <code>Localizer</code> class provides consumers with
62  * a simple localization tools: <code>getString(key)</code>.
63  * Locale and ResourceBundle need to be set to use it.
64  *
65  * @author <a HREF="mailto:wolf@paulus.com">Wolf Paulus</a>
66  * @version $Revision: 1.2 $
67  *
68  */
69 public class Localizer {
70   private Locale JavaDoc locale = Locale.getDefault();
71   private String JavaDoc bundleName;
72   private ResourceBundle JavaDoc bundle;
73   private ClassLoader JavaDoc cl = Localizer.class.getClassLoader();
74
75   /**
76    * Returns the localized String baseed on the given key.
77    * If the key cannot be found, the key is returned insstead.
78    * @param key <code>String</code>
79    * @return <code>String</code> - localized String , or key , if no lacalization is found.
80    */
81   public String JavaDoc getString( final String JavaDoc key ) {
82     if (!isUsable()) return key;
83     String JavaDoc s;
84     try {
85       s = bundle.getString( key );
86     } catch (Exception JavaDoc e) {
87       s = key; // key not found, return key
88 }
89     return s;
90   }
91
92   /**
93    * Sets this Localizer's locale.
94    * @param locale <code>Locale</code>
95    */
96   public void setLocale( Locale JavaDoc locale ) {
97     if (locale==null) {
98       this.locale= null;
99       this.bundle = null;
100       this.bundleName = null;
101     } else if (this.locale != locale) {
102       this.locale = locale;
103       setResourceBundle( bundleName );
104     }
105   }
106
107   /**
108    * Sets this Localizer's ResourceBundle
109    * @param bundleName <code>String</code>ResourceBundle file / class name
110    */
111   public void setResourceBundle( String JavaDoc bundleName ) throws MissingResourceException JavaDoc {
112     this.bundleName = bundleName;
113     if (locale==null) {
114       locale= Locale.getDefault();
115     }
116     if (bundleName != null) {
117       bundle = ResourceBundle.getBundle( bundleName, locale, cl );
118     } else {
119       bundle = null;
120     }
121   }
122
123   /**
124    * Informs about the usablility of this Localizer.
125    * @return <code>boolean</code> - true if Localizer is setup with Locale and ResourceBundle.
126    */
127   public boolean isUsable() {
128     return (locale!=null && bundle!=null);
129   }
130
131   /**
132    * @return <code>ClassLoader</code> returns the classloader attribute, which has probably been set by the SwingEngine
133    */
134   public ClassLoader JavaDoc getClassLoader() {
135     return cl;
136   }
137
138   /**
139    * Sets the ClassLoader attribute.
140    * The Localizer does not use the provided classloader directly but return it when asked for.
141    * @param cl
142    */
143   void setClassLoader( ClassLoader JavaDoc cl ) {
144     this.cl = cl;
145   }
146 }
147
Popular Tags