JGit 7.2.0.202503040940-r · 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

Modifier and Type	Field and Description
private static final InheritableThreadLocal<NLS>	local
private final Locale	locale
private final Map<Class<T>, TranslationBundle>	map
public static final Locale	ROOT_LOCALE The root locale constant.

Constructor Summary

Access	Constructor and Description
private	NLS(Locale locale)

Method Summary

Modifier and Type	Method and Description
public static void	clear() Release resources held by NLS
private <T extends TranslationBundle> T	get(Class<T> type)
public static < type of the translation bundle T extends TranslationBundle> T	Returns: an instance of the required bundle type getBundleFor(Class<T> required bundle type type) Returns an instance of the translation bundle of the required type.
public static void	setLocale(Locale the preferred locale locale) Sets the locale for the calling thread.
private static NLS	useJVMDefaultInternal()
public static void	useJVMDefaultLocale() Sets the JVM default locale as the locale for the calling thread.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

local	back to summary
private static final InheritableThreadLocal<NLS> local

locale	back to summary
private final Locale locale

map	back to summary
private final Map<Class<T>, TranslationBundle> map

ROOT_LOCALE	back to summary
public static final Locale ROOT_LOCALE The root locale constant. It is defined here because the Locale.ROOT is not defined in Java 5

Constructor Detail

NLS	back to summary
private NLS(Locale locale)

Method Detail

clear	back to summary
public static void clear() Release resources held by NLS Since 5.8

clear

back to summary

public static void clear()

Release resources held by NLS

Since: 5.8

get	back to summary
private <T extends TranslationBundle> T get(Class<T> type) Annotations @SuppressWarnings:unchecked

getBundleFor back to summary

getBundleFor	back to summary
public static <T extends TranslationBundle> T getBundleFor(Class<T> type) 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 the `org.eclipse.jgit.nls.TranslationBundle`. Parameters <T> type of the translation bundle type:Class<T> required bundle type Returns:T an instance of the required bundle type Exceptions TranslationBundleLoadingException: see `org.eclipse.jgit.errors.TranslationBundleLoadingException` TranslationStringMissingException: see `org.eclipse.jgit.errors.TranslationStringMissingException`

public static <T extends TranslationBundle> T getBundleFor(Class<T> type)

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 the org.eclipse.jgit.nls.TranslationBundle.

Parameters

<T>: type of the translation bundle
type:Class<T>: required bundle type

Returns:T

an instance of the required bundle type

Exceptions

TranslationBundleLoadingException:: see org.eclipse.jgit.errors.TranslationBundleLoadingException
TranslationStringMissingException:: see org.eclipse.jgit.errors.TranslationStringMissingException

setLocale back to summary

setLocale	back to summary
public static void setLocale(Locale locale) 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 the `TranslationBundle` Parameters locale:Locale the preferred locale

public static void setLocale(Locale locale)

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 the TranslationBundle

Parameters

locale:Locale: the preferred locale

useJVMDefaultInternal	back to summary
private static NLS useJVMDefaultInternal()

useJVMDefaultLocale back to summary

useJVMDefaultLocale	back to summary
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())`.

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()).