1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
package tim.prune;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Enumeration;
import java.util.IllegalFormatException;
import java.util.Locale;
import java.util.MissingResourceException;
import java.util.Properties;
import java.util.ResourceBundle;
/**
* Manager for all internationalization
* Responsible for loading property files
* and delivering language-specific texts
*/
public abstract class I18nManager
{
/** Properties object into which all the texts are copied */
private static Properties _localTexts = null;
/** External properties file for developer testing */
private static Properties _externalPropsFile = null;
/**
* Initialize the library using the (optional) locale
* @param inLocale locale to use, or null for default
*/
public static void init(Locale inLocale)
{
final String BUNDLE_NAME = "tim.prune.lang.prune-texts";
final Locale BACKUP_LOCALE = new Locale("en", "GB");
_localTexts = new Properties();
// Load English texts first to use as defaults
loadFromBundle(ResourceBundle.getBundle(BUNDLE_NAME, BACKUP_LOCALE));
// Get bundle for selected locale, if any
try
{
if (inLocale != null)
{
loadFromBundle(ResourceBundle.getBundle(BUNDLE_NAME, inLocale));
}
else
{
// locale is null so just use the system default
loadFromBundle(ResourceBundle.getBundle(BUNDLE_NAME, Locale.getDefault()));
}
}
catch (MissingResourceException mre) { // ignore error, default to english
}
}
/**
* Copy all the translations from the given bundle and store in the Properties object
* overwriting the existing translations if necessary
* @param inBundle bundle object loaded from file
*/
private static void loadFromBundle(ResourceBundle inBundle)
{
Enumeration<String> e = inBundle.getKeys();
while (e.hasMoreElements())
{
String key = e.nextElement();
_localTexts.setProperty(key, inBundle.getString(key));
}
}
/**
* Add a language file
* @param inFilename filename of file
* @throws FileNotFoundException if load failed
*/
public static void addLanguageFile(String inFilename) throws FileNotFoundException
{
boolean fileLoaded = false;
File file = new File(inFilename);
_externalPropsFile = new Properties();
try (FileInputStream fis = new FileInputStream(file))
{
_externalPropsFile.load(fis);
fileLoaded = true; // everything worked
}
catch (IOException ioe) {}
// complain if file wasn't loaded, by throwing a filenotfound exception
if (!fileLoaded) {
throw new FileNotFoundException();
}
}
/**
* Lookup the given key and return the associated text
* @param inKey key to lookup
* @return associated text, or the key if not found
*/
public static String getText(String inKey)
{
// look in external props file if available
if (_externalPropsFile != null)
{
String extText = _externalPropsFile.getProperty(inKey);
if (extText != null) return extText;
}
// look in texts if available
if (_localTexts != null)
{
try
{
String localText = _localTexts.getProperty(inKey);
if (localText != null) return localText;
}
catch (MissingResourceException mre) {}
}
// return the key itself
return inKey;
}
/**
* Lookup the given key and return the associated text, formatting with the number
* @param inKey key to lookup (text should contain a %s)
* @param inPlaceholderValue value to substitute into the %s
* @return associated text, or the key if not found
*/
public static String getText(String inKey, String inPlaceholderValue)
{
String localText = getText(inKey);
try {
localText = String.format(localText, inPlaceholderValue);
}
catch (IllegalFormatException e)
{} // printf formatting didn't work, maybe the placeholders are wrong?
return localText;
}
/**
* Lookup the given key and return the associated text, formatting with the number
* @param inKey key to lookup (text should contain two elements with %s)
* @param inValue1 value to substitute into the first %s
* @param inValue2 value to substitute into the second %s
* @return associated text, or the key if not found
*/
public static String getText(String inKey, String inValue1, String inValue2)
{
String localText = getText(inKey);
try {
localText = String.format(localText, inValue1, inValue2);
}
catch (IllegalFormatException e)
{} // printf formatting didn't work, maybe the placeholders are wrong?
return localText;
}
/**
* Lookup the given key and return the associated text, formatting with the number
* @param inKey key to lookup (text should contain a %d)
* @param inNumber number to substitute into the %d
* @return associated text, or the key if not found
*/
public static String getTextWithNumber(String inKey, int inNumber)
{
String localText = getText(inKey);
try {
localText = String.format(localText, inNumber);
}
catch (IllegalFormatException e)
{} // printf formatting didn't work, maybe the placeholders are wrong?
return localText;
}
}
|
