Package org.eclipse.jgit.nls
Class TranslationBundle
java.lang.Object
org.eclipse.jgit.nls.TranslationBundle
- Direct Known Subclasses:
ArchiveText
,BCText
,CLIText
,DfsText
,HttpApacheText
,HttpServerText
,JGitText
,JSchText
,LfsServerText
,LfsText
,RepoText
,SshdText
,UIText
Base class for all translation bundles that provides injection of translated
texts into public String fields.
The usage pattern is shown with the following example. First define a new translation bundle:
public class TransportText extends TranslationBundle { public static TransportText get() { return NLS.getBundleFor(TransportText.class); } public String repositoryNotFound; public String transportError; }Second, define one or more resource bundle property files.
TransportText_en_US.properties: repositoryNotFound=repository {0} not found transportError=unknown error talking to {0} TransportText_de.properties: repositoryNotFound=repository {0} nicht gefunden transportError=unbekannter Fehler während der Kommunikation mit {0} ...Then make use of it:
NLS.setLocale(Locale.GERMAN); // or skip this call to stick to the JVM default locale ... throw new TransportException(uri, TransportText.get().transportError);The translated text is automatically injected into the public String fields according to the locale set with
NLS.setLocale(Locale)
. However, the
NLS.setLocale(Locale)
method defines only
prefered locale which will be honored only if it is supported by the provided
resource bundle property files. Basically, this class will use
ResourceBundle.getBundle(String, Locale)
method to load a
resource bundle. See the documentation of this method for a detailed
explanation of resource bundle loading strategy. After a bundle is created
the effectiveLocale()
method can be used to determine whether the
bundle really corresponds to the requested locale or is a fallback.
To load a String from a resource bundle property file this class uses the
ResourceBundle.getString(String)
. This method can throw the
MissingResourceException
and this class is not making any
effort to catch and/or translate this exception.
To define a concrete translation bundle one has to:
- extend this class
- define a public static get() method like in the example above
- define public static String fields for each text message
- make sure the translation bundle class provide public no arg constructor
- provide one or more resource bundle property files in the same package where the translation bundle class resides
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the locale used for loading the resource bundle from which the field values were taken.(package private) void
Injects locale specific text in all instance fields of this instance.Get the resource bundle on which this translation bundle is based.
-
Field Details
-
effectiveLocale
-
resourceBundle
-
-
Constructor Details
-
TranslationBundle
public TranslationBundle()
-
-
Method Details
-
effectiveLocale
Get the locale used for loading the resource bundle from which the field values were taken.- Returns:
- the locale used for loading the resource bundle from which the field values were taken.
-
resourceBundle
Get the resource bundle on which this translation bundle is based.- Returns:
- the resource bundle on which this translation bundle is based.
-
load
Injects locale specific text in all instance fields of this instance. Only public instance fields of typeString
are considered.The name of this (sub)class plus the given
locale
parameter define the resource bundle to be loaded. In other words thethis.getClass().getName()
is used as thebaseName
parameter in theResourceBundle.getBundle(String, Locale)
parameter to load the resource bundle.- Parameters:
locale
- defines the locale to be used when loading the resource bundle- Throws:
TranslationBundleLoadingException
- seeTranslationBundleLoadingException
TranslationStringMissingException
- seeTranslationStringMissingException
-