blob: 6cd9fd88859af645f4f92cfc9fc7cf66a50d3b44 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2012 Dirk Fauth and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Dirk Fauth <dirk.fauth@gmail.com> - initial API and implementation
******************************************************************************/
package org.eclipse.e4.tools.services.impl;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
/**
* Wrapper class for accessing translations out of a {@link ResourceBundle}.
*
* @author Dirk Fauth
*
*/
public class ResourceBundleTranslationProvider {
/**
* The {@link ResourceBundle} to use for translations.
*/
private ResourceBundle resourceBundle;
/**
*
* @param resourceBundle The {@link ResourceBundle} to use for translations.
* Can be <code>null</code>, which will lead to simply return the key
* modified by prefixing and suffixing it with "!" when calling translate(String).
*/
public ResourceBundleTranslationProvider(ResourceBundle resourceBundle) {
this.setResourceBundle(resourceBundle);
}
/**
* Tries to retrieve the translation value for the given key out of the {@link ResourceBundle}
* set to this {@link ResourceBundleTranslationProvider}. If there is no {@link ResourceBundle}
* set or there is no translation found for the given key, the key itself prefixed and suffixed
* with "!" will be returned to indicate that there is no translation found.
* <p>This implementation also supports the usage of dot separation for property keys. As in Java
* variables can not be separated with a dot, the underscore needs to be used for separation of
* the variable. This will be replaced automatically to a dot, if there is no translation found
* with an underscore as separator.
* </p>
* @param key The key of the requested translation property.
* @return The translation for the given key or the key itself prefixed and suffixed
* with "!" to indicate that there is no translation available for the
* given key.
*/
public String translate(String key) {
String result = ""; //$NON-NLS-1$
try {
if (this.resourceBundle == null) {
result = "!" + key + "!"; //$NON-NLS-1$ //$NON-NLS-2$
}
else {
result = this.resourceBundle.getString(key);
}
} catch (MissingResourceException e) {
if (key.contains("_")) { //$NON-NLS-1$
result = translate(key.replace('_', '.'));
} else {
result = "!" + key + "!"; //$NON-NLS-1$ //$NON-NLS-2$
}
}
return result;
}
/**
* @return The {@link ResourceBundle} that is used for translations.
*/
public ResourceBundle getResourceBundle() {
return resourceBundle;
}
/**
* @param resourceBundle The {@link ResourceBundle} to use for translations.
*/
public void setResourceBundle(ResourceBundle resourceBundle) {
this.resourceBundle = resourceBundle;
}
}
|
