java.lang.Object
org.eclipse.jgit.nls.NLS
The purpose of this class is to provide NLS (National Language Support)
configurable per thread.
The setLocale(Locale)
method is used to configure locale for the
calling thread. The locale setting is thread inheritable. This means that a
child thread will have the same locale setting as its creator thread until it
changes it explicitly.
Example of usage:
NLS.setLocale(Locale.GERMAN); TransportText t = NLS.getBundleFor(TransportText.class);
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic void
clear()
Release resources held by NLSstatic <T extends TranslationBundle>
TgetBundleFor
(Class<T> type) Returns an instance of the translation bundle of the required type.static void
Sets the locale for the calling thread.static void
Sets the JVM default locale as the locale for the calling thread.
-
Field Details
-
ROOT_LOCALE
The root locale constant. It is defined here because the Locale.ROOT is not defined in Java 5
-
-
Method Details
-
setLocale
Sets the locale for the calling thread.The
getBundleFor(Class)
method will honor this setting if it is supported by the provided resource bundle property files. Otherwise, it will use a fall back locale as described in theTranslationBundle
- Parameters:
locale
- the preferred locale
-
useJVMDefaultLocale
public static void useJVMDefaultLocale()Sets the JVM default locale as the locale for the calling thread.Semantically this is equivalent to
NLS.setLocale(Locale.getDefault())
. -
getBundleFor
Returns an instance of the translation bundle of the required type. All public String fields of the bundle instance will get their values injected as described in theTranslationBundle
.- Type Parameters:
T
- type of the translation bundle- Parameters:
type
- required bundle type- Returns:
- an instance of the required bundle type
- Throws:
TranslationBundleLoadingException
- seeTranslationBundleLoadingException
TranslationStringMissingException
- seeTranslationStringMissingException
-
clear
public static void clear()Release resources held by NLS- Since:
- 5.8
-