L10n (MyTISM API Documentation)

java.lang.Object
- de.ipcon.tools.L10n

All Implemented Interfaces:

L10nPackProviderI
```
public final class L10n
extends java.lang.Object
implements L10nPackProviderI
```
A utility class providing a comprehensive collection of static functions to facilitate various localization (L10n) jobs without requiring deep knowledge of the underlying L10n system's intricacies.
This class implements L10nPackProviderI, indicating its role in providing localization packs. It encapsulates common L10n operations, aiming to simplify the process of retrieving, formatting, and managing localized strings within the application.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class L10n.SimpleL10nLocaleProvider

static class L10n.UnresolvedMessage

Nested Classes
Modifier and Type	Class and Description
`static class`	`L10n.SimpleL10nLocaleProvider`
`static class`	`L10n.UnresolvedMessage`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Object`	`defaultLocaleLock` If the default locale is changed in a multithreaded environment via `setDefaultLocale()` this will influence all threads of course, as it is a global value.
`static java.util.regex.Pattern`	`l10nTagPattern`
`static java.lang.String`	`PACK_SEPARATOR`
`static java.util.regex.Pattern`	`validBundleNamePattern` A compiled regular expression Pattern that defines the set of characters considered valid for L10n bundle names.
`static java.util.regex.Pattern`	`validPackagePattern` A compiled regular expression Pattern that defines the set of characters considered valid for package names.
`static java.lang.String`	`validResourceKeyChars` A constant String defining the set of characters considered valid for L10n resource keys.
`static java.util.regex.Pattern`	`validResourceKeyPattern` A compiled regular expression Pattern that defines the set of characters considered valid for L10n resource keys.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`activateCompilePathDebugging()`
`static void`	`activateMsgDebugging()`
`static void`	`activateMsgDebugging(java.lang.String key)`
`static void`	`activateValidPackDebugging()`
`static void`	`activateValidPackDebugging(java.lang.String key)`
`static void`	`addLocaleChangeListener(L10nLocaleChangeListenerI _lcl)`
`static void`	`addPathCompilerForClass(java.lang.Class clazz, L10nPathCompilerI compiler)` Registers an L10nPathCompilerI instance for a specific class.
`static void`	`addPreloadL10nCacheFinishedListener(PreloadL10nCacheFinishedListenerI l)`
`static void`	`appendPackProvider(L10nPackProviderI p)`
`static electric.xml.Document`	`applyL10n(electric.xml.Document _doc, java.lang.Object[] _path)`
`static electric.xml.Document`	`applyL10n(electric.xml.Document _doc, java.lang.Object[] _path, java.lang.String _localeName)`
`static void`	`applyL10n(electric.xml.Element _el, java.lang.Object[] _path)`
`static void`	`applyL10n(electric.xml.Element _el, java.lang.Object[] _path, java.lang.String _localeName)`
`static java.lang.String`	`applyL10n(java.lang.String in, java.lang.Object[] path)` Replaces $R{...} in given String by appropriate texts and returns the result.
`static java.lang.String`	`applyL10n(java.lang.String in, java.lang.Object[] path, java.lang.String localeName)`
`static java.lang.String`	`applyL10nLocale(java.lang.String in, java.lang.Object[] path, java.util.Locale locale)`
`static java.lang.String`	`canonifyPackageName(java.lang.String s)` Removes inner class parts (indicated by '$') from a package name.
`static java.lang.String[]`	`compilePath(java.lang.Object[] participants)` Compiles and returns a list of L10nBundle names derived from the provided participant objects.
`static void`	`deactivateCompilePathDebugging()`
`static void`	`deactivateMsgDebugging()`
`static void`	`deactivateValidPackDebugging()`
`static void`	`firePathCompilersChanged()`
`static void`	`flushCache()`
`static void`	`flushCache(java.lang.String bundle)`
`static void`	`flushCache(java.lang.String[] bundles)`
`static java.lang.String`	`formatDate(java.util.Date d)` usage with locale not recommended as they are not being cached, which leads to poor performance. the locale can instead be stored in the pattern-string
`static java.lang.String`	`formatDate(java.util.Date d, java.lang.String pattern)`
`static java.lang.String`	`formatDate(java.util.Date d, java.lang.String pattern, java.util.Locale _locale)`
`static java.lang.String`	`formatDate(java.util.Date d, java.lang.String pattern, java.util.Locale _locale, java.util.TimeZone timeZone)`
`static java.lang.String`	`formatDateNT(java.util.Date d)` null safe version of formatDate with fallback if date is null
`static java.lang.String`	`formatDateNT(java.util.Date d, java.lang.String pattern)`
`static java.lang.String`	`formatDateNT(java.util.Date d, java.lang.String pattern, java.util.Locale locale)`
`static java.lang.String`	`formatDateNT(java.util.Date d, java.lang.String pattern, java.util.Locale locale, java.lang.String fallback)`
`static java.lang.String`	`formatDateNT(java.util.Date d, java.lang.String pattern, java.lang.String fallback)` null safe version of formatDate with fallback if date is null
`static java.lang.String`	`formatDecimal(java.lang.Number n)`
`static java.lang.String`	`formatDecimal(java.lang.Number n, java.lang.String pattern)`
`static java.lang.String`	`formatDecimal(java.lang.Number n, java.lang.String pattern, java.util.Locale _locale)`
`static java.lang.String`	`formatDecimalNT(java.lang.Number n)` null safe version of formatDecimal with fallback if number is null
`static java.lang.String`	`formatDecimalNT(java.lang.Number n, java.lang.String pattern)`
`static java.lang.String`	`formatDecimalNT(java.lang.Number n, java.lang.String pattern, java.util.Locale locale)`
`static java.lang.String`	`formatDecimalNT(java.lang.Number n, java.lang.String pattern, java.util.Locale locale, java.lang.String fallback)`
`static java.lang.String`	`formatDecimalNT(java.lang.Number n, java.lang.String pattern, java.lang.String fallback)` null safe version of formatDecimal with fallback if number is null
`static java.lang.String`	`formatDuration(javax.xml.datatype.Duration _dur)`
`static java.lang.String`	`formatDuration(javax.xml.datatype.Duration _dur, java.lang.String _pattern)`
`static java.lang.String`	`formatDuration(javax.xml.datatype.Duration _dur, java.lang.String _pattern, java.util.Locale _locale)`
`static java.lang.String`	`formatISO8601(java.util.Date date)` Returns the given Date in an ISO8601:2019 conformant String.
`static java.lang.String`	`formatISO8601(java.util.Date date, boolean withLocalTimeZone)`
`static java.lang.String`	`formatISO8601NT(java.util.Date date)` Not throwing version of `#formatISO8601Date(Date, boolean)`.
`static java.lang.String`	`formatISO8601NT(java.util.Date date, java.lang.String fallback)`
`static java.lang.String`	`formatISO8601NT(java.util.Date date, java.lang.String fallback, boolean withLocalTimeZone)`
`static java.lang.String`	`formatISODate(java.util.Date d)` Formats the given Date in ISO8601 like format, with the 'T' replaced by a space.
`static java.lang.String`	`formatISODateNT(java.util.Date d)` null safe version of formatISODate with fallback if date is null
`static java.lang.String`	`formatISODateNT(java.util.Date d, java.lang.String fallback)`
`static java.lang.String`	`formatTimespan(java.lang.Number _ts)`
`static java.lang.String`	`formatTimespan(java.lang.Number _ts, java.lang.String _pattern)`
`static java.lang.String`	`formatTimespan(java.lang.Number _ts, java.lang.String _pattern, java.util.Locale _locale)`
`static java.lang.String[]`	`getAutoPath()` Returns path compiled by using info from current StackTrace.
`static java.lang.String[]`	`getAutoPath(int _stackOffset)`
`static java.text.Collator`	`getCollator()` returns a Collator for the current default locale, but makes it space sensitive
`static java.text.Collator`	`getCollator(java.util.Locale l)`
`static java.text.Collator`	`getCollator(java.util.Locale l, java.lang.String parms)`
`static L10nCurrentLocaleProviderI`	`getCurrentLocaleProvider()` Gets the locale provider for the current Thread.
`static java.util.Locale`	`getCurrentLocaleViaProvider()` Returns the current locale for the current Thread.
`static L10nDateFormat`	`getDateFormat()`
`static L10nDateFormat`	`getDateFormat(java.lang.String _pattern)`
`static L10nDateFormat`	`getDateFormat(java.lang.String _pattern, java.util.Locale _locale)`
`static L10nDateFormat`	`getDateFormat(java.lang.String _pattern, java.util.Locale _locale, java.util.TimeZone timeZone)`
`static L10nDecimalFormat`	`getDecimalFormat()` Factory method to obtain locale-sensitive `DecimalFormat` objects.
`static L10nDecimalFormat`	`getDecimalFormat(java.lang.String _pattern)`
`static L10nDecimalFormat`	`getDecimalFormat(java.lang.String _pattern, java.util.Locale _locale)`
`static java.util.Locale`	`getDefaultLocale()`
`static java.lang.String`	`getDefaultLocaleName()`
`static java.util.function.Supplier<java.lang.String>`	`getGetCallingClassNameImplementation()`
`L10nPack`	`getL10nPack(java.lang.String name, java.lang.String localeName)` Retrieves a specific `L10nPack` by its bundle name and locale.
`L10nPack[]`	`getL10nPacks(java.lang.String[] bundles, java.lang.String localeName)` Retrieves an array of `L10nPack` objects for multiple specified bundle names and a single locale.
`L10nPathEntry[]`	`getL10nPath()` Retrieves the localization path entries provided by this pack provider.
`java.lang.String`	`getL10nViaString()` Provides a descriptive string indicating the means by which localization (L10n) data was delivered.
`static java.lang.String`	`getLanguageSeperatedByDash(java.lang.String _str, int _lang)` this method takes a String where the languages are seperated by \| it returns the _lang'th language of this string, beginning at 1
`static java.util.Locale`	`getLocaleFromString(java.lang.String s)`
`static java.lang.String`	`getMsgDebuggingActiveForKey()`
`static L10nPack`	`getPack(java.lang.String[] path, int index)` Retrieves a localization pack (L10nPack) based on the provided path, index, and locale.
`static L10nPack`	`getPack(java.lang.String[] path, int index, java.lang.String localeName)`
`static L10nTimespanFormat`	`getTimespanFormat()`
`static L10nTimespanFormat`	`getTimespanFormat(java.lang.String pattern)`
`static L10nTimespanFormat`	`getTimespanFormat(java.lang.String pattern, java.util.Locale locale)`
`static java.lang.String`	`getValidPackDebuggingActiveForKey()`
`static java.lang.String`	`getWaehrungsSymbol(java.lang.String isocode)`
`L10nPack`	`internalGetL10nPack(java.lang.String name, java.lang.String localeName)` Loads L10nPack from *.properties file resources via classpath and getResourceAsStream().
`static boolean`	`isCompilePathDebuggingActive()`
`static boolean`	`isMsgDebuggingActive()`
`boolean`	`isOperational()` Checks if this L10n pack provider is currently operational and ready to serve requests.
`static boolean`	`isParentOf(java.util.Locale supposedParent, java.util.Locale supposedChild)`
`static boolean`	`isValidPackDebuggingActive()`
`static void`	`logCompiledPath(java.lang.Object[] participants, java.util.LinkedHashSet<java.lang.String> compiledPath)`
`static void`	`logMsg(java.lang.String msg, java.lang.String msgTemplate, java.lang.String key, java.lang.Object[] args, java.lang.String[] path, boolean returnKeyWhenNotFound, java.lang.String localeName, boolean useFallbackLocale)`
`static void`	`logValidPack(L10nPack pack, java.lang.String key, java.lang.String[] path, java.lang.String localeName)`
`static java.lang.String`	`msg(java.lang.String key)` Convenience frontend that automatically compiles the path by getting the calling class from the current StackTrace.
`static java.lang.String`	`msg(java.lang.String key, byte arg0)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, int arg0)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, long arg0)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, java.lang.Number arg0)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, int stackOffset)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.Object[] _participants)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.Object[] _participants, boolean returnKeyWhenNotFound)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.Object[] _participants, boolean returnKeyWhenNotFound, java.util.Locale locale)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.Object[] _participants, boolean returnKeyWhenNotFound, java.lang.String localeName)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.String[] path)` Retrieves a localized and formatted message based on a given key, arguments, and lookup path, with various fallback options.
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.String[] path, boolean returnKeyWhenNotFound)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.String[] path, boolean returnKeyWhenNotFound, java.lang.String localeName)`
`static java.lang.String`	`msg(java.lang.String key, java.lang.Object[] args, java.lang.String[] path, boolean returnKeyWhenNotFound, java.lang.String localeName, boolean useFallbackLocale)`
`static java.lang.String`	`msg(java.lang.String key, short arg0)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, java.lang.String arg0)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, java.lang.String arg0, java.lang.String arg1)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msg(java.lang.String key, java.lang.String arg0, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)` Convenience frontend for `#msg(String, Object[])`.
`static java.lang.String`	`msgNoFormat(java.lang.String key)` Convenience frontend that automatically compiles the path by getting the calling class from the current StackTrace.
`static java.lang.String`	`msgNoFormat(java.lang.String key, int stackOffset)`
`static java.lang.String`	`msgNoFormat(java.lang.String key, java.lang.String[] path)` Gets the matching message template string for key, etc.
`static java.lang.String`	`msgNoFormat(java.lang.String key, java.lang.String[] path, java.lang.String localeName)`
`static java.lang.String`	`msgNoKey(java.lang.String key)` Convenience frontend that automatically compiles the path by getting the calling class from the current StackTrace.
`static java.lang.String`	`msgNoKey(java.lang.String key, java.lang.Object[] args)`
`static java.lang.String`	`msgNoKey(java.lang.String key, java.lang.Object[] args, int stackOffset)`
`static java.util.Date`	`parseDate(java.lang.String s)` usage with locale not recommended as they are not being cached, which leads to poor performance. the locale can instead be stored in the pattern-string
`static java.util.Date`	`parseDate(java.lang.String s, java.lang.String pattern)`
`static java.util.Date`	`parseDate(java.lang.String s, java.lang.String[] patterns)` usage with locale not recommended as they are not being cached which leads to poor performance. the locale can instead be stored in the pattern-string
`static java.util.Date`	`parseDate(java.lang.String s, java.lang.String[] patterns, java.util.Locale _locale)`
`static java.util.Date`	`parseDate(java.lang.String s, java.lang.String[] patterns, java.util.Locale _locale, java.util.TimeZone timeZone)`
`static java.util.Date`	`parseDate(java.lang.String s, java.lang.String pattern, java.util.Locale _locale)`
`static java.util.Date`	`parseDate(java.lang.String s, java.lang.String pattern, java.util.Locale _locale, java.util.TimeZone timeZone)`
`static java.util.Date`	`parseDateNT(java.lang.String s)` wrapper for parseDate that throws no exception. if an exception is caught, fallback is returned, which defaults to null
`static java.util.Date`	`parseDateNT(java.lang.String s, java.lang.String pattern)`
`static java.util.Date`	`parseDateNT(java.lang.String s, java.lang.String[] patterns)` wrapper for parseDate that throws no exception. if an exception is caught, fallback is returned, which defaults to null
`static java.util.Date`	`parseDateNT(java.lang.String s, java.lang.String[] patterns, java.util.Date fallback)`
`static java.util.Date`	`parseDateNT(java.lang.String s, java.lang.String pattern, java.util.Date fallback)`
`static java.math.BigDecimal`	`parseDecimal(java.lang.String s)` Method to parse a L10n formatted Number in a String to the represented BigDecimal value.
`static java.math.BigDecimal`	`parseDecimal(java.lang.String s, java.lang.String pattern)`
`static java.math.BigDecimal`	`parseDecimal(java.lang.String s, java.lang.String[] patterns)`
`static java.math.BigDecimal`	`parseDecimal(java.lang.String s, java.lang.String[] patterns, java.util.Locale _locale)`
`static java.math.BigDecimal`	`parseDecimal(java.lang.String s, java.lang.String pattern, java.util.Locale _locale)`
`static java.math.BigDecimal`	`parseDecimalNT(java.lang.String s)` wrapper for parseDecimal that throws no exception. if an exception is caught, fallback is returned, which defaults to null
`static java.math.BigDecimal`	`parseDecimalNT(java.lang.String s, java.lang.String pattern)`
`static java.math.BigDecimal`	`parseDecimalNT(java.lang.String s, java.lang.String[] patterns)` wrapper for parseDecimal that throws no exception. if an exception is caught, fallback is returned, which defaults to null
`static java.math.BigDecimal`	`parseDecimalNT(java.lang.String s, java.lang.String[] patterns, java.math.BigDecimal fallback)`
`static java.math.BigDecimal`	`parseDecimalNT(java.lang.String s, java.lang.String pattern, java.math.BigDecimal fallback)`
`static javax.xml.datatype.Duration`	`parseDuration(java.lang.String s)`
`static java.util.Date`	`parseISO8601(java.lang.String s)` Parses an ISO8601:2019 conform Datetime text, returning the parameter as Date.
`static java.util.Date`	`parseISO8601NT(java.lang.String s)` Non-throw version of `parseISO8601(String)`, returning the fallback if the given String is not a valid ISO date
`static java.util.Date`	`parseISO8601NT(java.lang.String s, java.util.Date fallback)`
`static java.util.Date`	`parseISODate(java.lang.String s)` Parses the given parameter as a ISO8601 like date, e.g. yyyy-MM-dd'T'HH:mm:ss.SSSX or yyyy-MM-dd, while trying to be a bit more tolerant regarding formatting errors.
`static java.util.Date`	`parseISODateNT(java.lang.String s)` wrapper for parseISODate thet throws no exception. if an exception is caught, fallback is returned, which defaults to null
`static java.util.Date`	`parseISODateNT(java.lang.String s, java.util.Date fallback)`
`static java.lang.Long`	`parseTimespan(java.lang.String _str)`
`static java.lang.Long`	`parseTimespan(java.lang.String _str, java.lang.String _pattern)`
`static java.lang.Long`	`parseTimespan(java.lang.String _str, java.lang.String[] _patterns)`
`static java.lang.Long`	`parseTimespan(java.lang.String _str, java.lang.String[] _patterns, java.util.Locale _locale)`
`static java.lang.Long`	`parseTimespan(java.lang.String _str, java.lang.String _pattern, java.util.Locale _locale)`
`static void`	`preloadCache(L10nPackProviderI providerForPreloading, L10nPack[] packsToPreload, java.lang.String localeName)`
`static void`	`prependPackProvider(L10nPackProviderI p)`
`static void`	`recalcPath()` Recalculates and updates the global lookup path for localization resources.
`static void`	`releaseDateFormat(L10nDateFormat df)`
`static void`	`releaseDecimalFormat(L10nDecimalFormat df)` Releases a `L10nDecimalFormat` instance back to the cache for potential reuse.
`static void`	`releaseTimespanFormat(L10nTimespanFormat df)`
`static void`	`removePackProvider(L10nPackProviderI p)`
`static void`	`removePathCompilerForClass(java.lang.Class clazz, L10nPathCompilerI compiler)` FIXME: (Currently) Not used.
`static L10n.UnresolvedMessage`	`resolveLater(java.lang.String msg, java.lang.Object participant)`
`static L10n.UnresolvedMessage`	`resolveLater(java.lang.String msg, java.lang.Object[] participants)`
`static L10n.UnresolvedMessage`	`resolveLater(java.lang.String msg, java.lang.Object[] parameters, java.lang.Object[] participants)`
`static void`	`setCurrentLocaleProvider(L10nCurrentLocaleProviderI p)` Sets the locale provider for the current Thread.
`static void`	`setDefaultLocale(java.util.Locale l)` Sets the static default locale value for the `L10n` class as well as the default locale of the JVM.
`static void`	`setDefaultLocaleName(java.lang.String s)`
`static L10nCurrentLocaleProviderI`	`setLocaleForCurrentThread(java.util.Locale locale)` Convenience frontend for `setCurrentLocaleProvider()` which automatically wraps the given `locale` into a new `SimpleL10nLocaleProvider` and sets that.
`static L10nCurrentLocaleProviderI`	`setLocaleNameForCurrentThread(java.lang.String localeName)`
`static java.lang.String[]`	`splitPath(java.lang.String _path)` Splits the given _path on '/' but ignoring '/' insided of $R{...} tags.
`static java.lang.String`	`stringToKey(java.lang.String _str)` Creates a usable L10n message key from a given String.
`static java.lang.String`	`stringToKey(java.lang.String _str, java.lang.String _prefix)`
`static L10nPack`	`validPack(java.lang.String key, java.lang.String[] path)` A valid L10nPack is where pack.getString(key) <> null
`static L10nPack`	`validPack(java.lang.String key, java.lang.String[] path, java.lang.String localeName)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.ipcon.tools.L10nPackProviderI
prefetchL10nPacks

- Field Detail
  - validPackagePattern
```
public static final java.util.regex.Pattern validPackagePattern
```
    A compiled regular expression Pattern that defines the set of characters considered valid for package names.
    This pattern allows for uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), underscores (_), hyphens (-), and dots (.).
  - validBundleNamePattern
```
public static final java.util.regex.Pattern validBundleNamePattern
```
    A compiled regular expression Pattern that defines the set of characters considered valid for L10n bundle names.
    This pattern allows for uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), and dots (.).
  - validResourceKeyChars
```
public static final java.lang.String validResourceKeyChars
```
    A constant String defining the set of characters considered valid for L10n resource keys.
    This string literal specifies that L10n resource keys can contain:
    - All uppercase letters (A-Z)
    - All lowercase letters (a-z)
    - Digits (0-9)
    - Underscores (_)
    - Hyphens (-)
    - Dots (.)
    - Tildes (~)
    - Forward slashes (/)
    This string is used to build the validResourceKeyPattern regex.
    See Also:
    
    Constant Field Values
  - validResourceKeyPattern
```
public static final java.util.regex.Pattern validResourceKeyPattern
```
    A compiled regular expression Pattern that defines the set of characters considered valid for L10n resource keys.
    This pattern is constructed using the characters defined in the validResourceKeyChars constant, ensuring that all characters allowed in a resource key match this pattern. Resource keys are used to uniquely identify localization resources within bundles.
  - l10nTagPattern
```
public static final java.util.regex.Pattern l10nTagPattern
```
  - PACK_SEPARATOR
```
public static final java.lang.String PACK_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - defaultLocaleLock
```
public static final java.lang.Object defaultLocaleLock
```
    If the default locale is changed in a multithreaded environment via setDefaultLocale() this will influence all threads of course, as it is a global value. If the default locale is changed on a temporary basis for some reasons this lock object should be used to synchronize those changes between threads to avoid unexpected problems or behaviour.
- Method Detail
  - activateCompilePathDebugging
```
public static final void activateCompilePathDebugging()
```
  - deactivateCompilePathDebugging
```
public static final void deactivateCompilePathDebugging()
```
  - isCompilePathDebuggingActive
```
public static final boolean isCompilePathDebuggingActive()
```
  - logCompiledPath
```
public static final void logCompiledPath(java.lang.Object[] participants,
                                         java.util.LinkedHashSet<java.lang.String> compiledPath)
```
  - activateMsgDebugging
```
public static final void activateMsgDebugging()
```
  - activateMsgDebugging
```
public static final void activateMsgDebugging(java.lang.String key)
```
  - deactivateMsgDebugging
```
public static final void deactivateMsgDebugging()
```
  - isMsgDebuggingActive
```
public static final boolean isMsgDebuggingActive()
```
  - getMsgDebuggingActiveForKey
```
public static final java.lang.String getMsgDebuggingActiveForKey()
```
  - logMsg
```
public static final void logMsg(java.lang.String msg,
                                java.lang.String msgTemplate,
                                java.lang.String key,
                                java.lang.Object[] args,
                                java.lang.String[] path,
                                boolean returnKeyWhenNotFound,
                                java.lang.String localeName,
                                boolean useFallbackLocale)
```
  - activateValidPackDebugging
```
public static final void activateValidPackDebugging()
```
  - activateValidPackDebugging
```
public static final void activateValidPackDebugging(java.lang.String key)
```
  - deactivateValidPackDebugging
```
public static final void deactivateValidPackDebugging()
```
  - isValidPackDebuggingActive
```
public static final boolean isValidPackDebuggingActive()
```
  - getValidPackDebuggingActiveForKey
```
public static final java.lang.String getValidPackDebuggingActiveForKey()
```
  - logValidPack
```
public static final void logValidPack(L10nPack pack,
                                      java.lang.String key,
                                      java.lang.String[] path,
                                      java.lang.String localeName)
```
  - applyL10nLocale
```
public static final java.lang.String applyL10nLocale(java.lang.String in,
                                                     java.lang.Object[] path,
                                                     java.util.Locale locale)
```
    See Also:
    
    #applyL10n(String, Object[], String), with the last parameter being the LanguageTag if locale is not null
  - applyL10n
```
public static final java.lang.String applyL10n(java.lang.String in,
                                               java.lang.Object[] path)
```
    Replaces $R{...} in given String by appropriate texts and returns the result.
    
    Parameters:
    
    in - input String containing $R{...} parts which shall be translated using L10nBundles
    
    path - an object array containing the names of the L10nBundles to use for looking up the keys
    
    localeName - the name of the locale to use for resolving the translated String, e.g. de, en, fr or even de_DE, fr_LU, de_LU etc.
    
    Returns:
    
    the input String with all occurences of $R{...} replaced by their appropriate Strings which were resolved from the L10nBundles in the system / in the path
  - applyL10n
```
public static final java.lang.String applyL10n(java.lang.String in,
                                               java.lang.Object[] path,
                                               java.lang.String localeName)
```
  - applyL10n
```
public static final electric.xml.Document applyL10n(electric.xml.Document _doc,
                                                    java.lang.Object[] _path)
```
  - applyL10n
```
public static final electric.xml.Document applyL10n(electric.xml.Document _doc,
                                                    java.lang.Object[] _path,
                                                    java.lang.String _localeName)
```
  - applyL10n
```
public static final void applyL10n(electric.xml.Element _el,
                                   java.lang.Object[] _path)
```
  - applyL10n
```
public static final void applyL10n(electric.xml.Element _el,
                                   java.lang.Object[] _path,
                                   java.lang.String _localeName)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         byte arg0)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and a single byte argument. It is intended for scenarios where only one byte argument is needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the l10n message template
    
    arg0 - the byte argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         short arg0)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and a single short argument. It is intended for scenarios where only one short argument is needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the l10n message template
    
    arg0 - the short argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         int arg0)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and a single int argument. It is intended for scenarios where only one int argument is needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the l10n message template
    
    arg0 - the int argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         long arg0)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and a single long argument. It is intended for scenarios where only one long argument is needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the l10n message template
    
    arg0 - the long argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Number arg0)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and a single Number argument. It is intended for scenarios where only one Number argument is needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the proper l10n entry
    
    arg0 - the Number argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.String arg0)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and a single String argument. It is intended for scenarios where only one String argument is needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the proper l10n entry
    
    arg0 - the String argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.String arg0,
                                         java.lang.String arg1)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and two String arguments. It is intended for scenarios where only two String arguments are needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the proper l10n entry
    
    arg0 - the first String argument to be substituted into the message template
    
    arg1 - the second String argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.String arg0,
                                         java.lang.String arg1,
                                         java.lang.String arg2)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and three String arguments. It is intended for scenarios where only three String arguments are needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the proper l10n entry
    
    arg0 - the first String argument to be substituted into the message template
    
    arg1 - the second String argument to be substituted into the message template
    
    arg2 - the third String argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.String arg0,
                                         java.lang.String arg1,
                                         java.lang.String arg2,
                                         java.lang.String arg3)
```
    Convenience frontend for #msg(String, Object[]).
    This method provides a simplified way to generate a message string using a key and four String arguments. It is intended for scenarios where only four String arguments are needed, thereby avoiding the need to create an array manually. *
    
    Parameters:
    
    key - the l10n key used to identify the proper l10n entry
    
    arg0 - the first String argument to be substituted into the message template
    
    arg1 - the second String argument to be substituted into the message template
    
    arg2 - the third String argument to be substituted into the message template
    
    arg3 - the fourth String argument to be substituted into the message template
    
    Returns:
    
    the l10n formatted message string based on the provided key and argument
  - msg
```
public static final java.lang.String msg(java.lang.String key)
```
    Convenience frontend that automatically compiles the path by getting the calling class from the current StackTrace.
    
    Parameters:
    
    stackOffset - not needed any more and ignored, but kept in for backwards compatibility.
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         int stackOffset)
```
  - msgNoKey
```
public static final java.lang.String msgNoKey(java.lang.String key)
```
    Convenience frontend that automatically compiles the path by getting the calling class from the current StackTrace.
    
    Parameters:
    
    stackOffset - not needed any more and ignored, but kept in for backwards compatibility.
  - msgNoKey
```
public static final java.lang.String msgNoKey(java.lang.String key,
                                              java.lang.Object[] args)
```
  - msgNoKey
```
public static final java.lang.String msgNoKey(java.lang.String key,
                                              java.lang.Object[] args,
                                              int stackOffset)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.Object[] _participants,
                                         boolean returnKeyWhenNotFound,
                                         java.util.Locale locale)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.Object[] _participants)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.Object[] _participants,
                                         boolean returnKeyWhenNotFound)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.Object[] _participants,
                                         boolean returnKeyWhenNotFound,
                                         java.lang.String localeName)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.String[] path)
```
    Retrieves a localized and formatted message based on a given key, arguments, and lookup path, with various fallback options.
    This method searches for the translation of the key within the specified path of localization bundles for the designated localeName. It supports dynamic insertion of arguments into the message template using MessageFormat.format(String, Object...).
    
    Parameters:
    
    key - The String key that needs to be translated using the L10n bundles.
    
    args - An Object array containing values to be inserted into the message template. These values replace placeholders like {0}, {1}, etc., in the translated string. Can be null.
    
    path - A String array containing the names of the L10n bundles to use for looking up the key. The bundles are searched in the order specified in this array.
    
    returnKeyWhenNotFound - A boolean flag. If true (default), and no matching bundle or key is found in the system or along the provided path (and no fallback locale is used or successful), the original key string will be returned as a fallback. If false, null will be returned in such cases.
    
    localeName - The String name of the locale to use for resolving the translated string (e.g., "de", "en", "fr" or more specific like "de_DE", "fr_LU", "de_LU"). If null, the default locale will be used.
    
    useFallbackLocale - A boolean flag. If true (default), and the key is not found in the specified localeName (i.e. in its associated bundle), the system will attempt to retrieve the message from a pre-configured fallback locale. If false, no fallback to the hardcoded fallback locale will occur.
    
    Returns:
    
    The appropriate localized String for the key, resolved from the L10n bundles in the system or in the path. The message template may also have been formatted with the provided arguments. Returns the original key, or null, depending on returnKeyWhenNotFound if no translation is found and no fallback is successful.
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.String[] path,
                                         boolean returnKeyWhenNotFound)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.String[] path,
                                         boolean returnKeyWhenNotFound,
                                         java.lang.String localeName)
```
  - msg
```
public static final java.lang.String msg(java.lang.String key,
                                         java.lang.Object[] args,
                                         java.lang.String[] path,
                                         boolean returnKeyWhenNotFound,
                                         java.lang.String localeName,
                                         boolean useFallbackLocale)
```
  - msgNoFormat
```
public static final java.lang.String msgNoFormat(java.lang.String key)
```
    Convenience frontend that automatically compiles the path by getting the calling class from the current StackTrace. FIXME is this used anywhere? at least not in this class...
    
    Parameters:
    
    stackOffset - not needed any more and ignored, but kept in for backwards compatibility.
  - msgNoFormat
```
public static final java.lang.String msgNoFormat(java.lang.String key,
                                                 int stackOffset)
```
  - msgNoFormat
```
public static final java.lang.String msgNoFormat(java.lang.String key,
                                                 java.lang.String[] path)
```
    Gets the matching message template string for key, etc.
    
    Parameters:
    
    key - the key (name) of the L10nResource to find
    
    path - the names of the L10nBundles in which the matching resource should be searched
    
    localeName - name of a locale (optional); if null the current one will be used
  - msgNoFormat
```
public static final java.lang.String msgNoFormat(java.lang.String key,
                                                 java.lang.String[] path,
                                                 java.lang.String localeName)
```
  - resolveLater
```
public static final L10n.UnresolvedMessage resolveLater(java.lang.String msg,
                                                        java.lang.Object[] parameters,
                                                        java.lang.Object[] participants)
```
  - resolveLater
```
public static final L10n.UnresolvedMessage resolveLater(java.lang.String msg,
                                                        java.lang.Object[] participants)
```
  - resolveLater
```
public static final L10n.UnresolvedMessage resolveLater(java.lang.String msg,
                                                        java.lang.Object participant)
```
  - validPack
```
public static final L10nPack validPack(java.lang.String key,
                                       java.lang.String[] path)
```
    A valid L10nPack is where pack.getString(key) <> null
  - validPack
```
public static final L10nPack validPack(java.lang.String key,
                                       java.lang.String[] path,
                                       java.lang.String localeName)
```
  - getAutoPath
```
public static final java.lang.String[] getAutoPath()
```
    Returns path compiled by using info from current StackTrace.
    
    Parameters:
    
    _stackOffset - not needed any more and ignored, but kept in for backwards compatibility.
  - getAutoPath
```
public static final java.lang.String[] getAutoPath(int _stackOffset)
```
  - getGetCallingClassNameImplementation
```
public static java.util.function.Supplier<java.lang.String> getGetCallingClassNameImplementation()
```
  - stringToKey
```
public static final java.lang.String stringToKey(java.lang.String _str)
```
    Creates a usable L10n message key from a given String.
    This method transforms the input string into a format suitable for use as a localization key. It performs the following steps:
    1. Replaces all characters that are not permitted in L10n resource keys (as defined by validResourceKeyChars) with underscores (_).
    2. Replaces any sequences of multiple underscores with a single underscore.
    3. Removes any leading or trailing underscores from the resulting string.
    4. If a _prefix is provided, it prepends this prefix to the processed string.
    FIXME: It is currently believed that the L10n system itself might not strictly enforce this key format. However, some methods within external components (e.g. in the Solstice Client) appear to perform checks that require keys to conform to a specific structure. While the strict necessity of this formatting remains somewhat uncertain, using this method to create keys is safe and will not cause problems, ensuring compatibility with potential external validation.
    Parameters:
    
    _str - The input String from which to create the L10n message key.
    
    _prefix - An optional String prefix to prepend to the generated key. If null, no prefix is added.
    
    Returns:
    
    A String representing the usable L10n message key.
  - stringToKey
```
public static final java.lang.String stringToKey(java.lang.String _str,
                                                 java.lang.String _prefix)
```
  - compilePath
```
public static final java.lang.String[] compilePath(java.lang.Object[] participants)
```
    Compiles and returns a list of L10nBundle names derived from the provided participant objects.
    This method takes a raw collection of objects involved in the bundle lookup process, which can include Business Object Types (BOTs), Business Objects (BOs), entities, other generic objects, or even null values. It processes these participants recursively to generate a concrete list of L10nBundle names that should be searched for localization keys.
    
    Parameters:
    
    participants - An array of Objects representing the participants in the bundle lookup.
    
    Returns:
    
    An array of Strings containing the compiled L10nBundle names. Returns an empty array if the input participants array is null or empty.
  - canonifyPackageName
```
public static final java.lang.String canonifyPackageName(java.lang.String s)
```
    Removes inner class parts (indicated by '$') from a package name. This method takes a package name string and removes any inner class suffixes, which are typically represented by a '$' followed by the inner class name.
    
    Parameters:
    
    s - The package name string to canonize.
    
    Returns:
    
    The canonized package name string.
  - addPathCompilerForClass
```
public static final void addPathCompilerForClass(java.lang.Class clazz,
                                                 L10nPathCompilerI compiler)
```
    Registers an L10nPathCompilerI instance for a specific class. This method allows classes to register singleton instances of their custom L10nPathCompilerI implementations. Multiple compilers can be registered for the same class, enabling flexible bundle lookup strategies.
    
    Parameters:
    
    clazz - The Class for which to register the compiler.
    
    compiler - The L10nPathCompilerI instance to register.
  - removePathCompilerForClass
```
public static final void removePathCompilerForClass(java.lang.Class clazz,
                                                    L10nPathCompilerI compiler)
```
    FIXME: (Currently) Not used. Deregisters the provided L10nPathCompilerI instance from the specified class. This method removes the association between the given L10nPathCompilerI and the class. If the compiler is not registered for the class, no action is taken.
    
    Parameters:
    
    clazz - The class from which the L10nPathCompilerI should be removed.
    
    compiler - The L10nPathCompilerI instance to deregister.
  - firePathCompilersChanged
```
public static final void firePathCompilersChanged()
```
  - isOperational
```
public boolean isOperational()
```
    Description copied from interface: L10nPackProviderI
    
    Checks if this L10n pack provider is currently operational and ready to serve requests.
    
    Specified by:
    
    isOperational in interface L10nPackProviderI
    
    Returns:
    
    true if the provider is operational, false otherwise.
  - getPack
```
public static final L10nPack getPack(java.lang.String[] path,
                                     int index)
```
    Retrieves a localization pack (L10nPack) based on the provided path, index, and locale.
    The process of loading localization packs is complex because it accounts for incomplete packs. An incomplete pack contains only a subset of keys, with the remaining keys being supplied by other L10n providers that have a lower priority in the lookup chain. Therefore, this method must query *all* available providers for their respective packs and then consolidate their entries using a "fill-in-missing" mechanism.
    
    The algorithm employed (using path and index) is a specialized optimization designed to minimize roundtrips to the underlying loading mechanism, particularly when interacting with a server. Instead of fetching each pack individually, this approach requests the path and an index. Upon the first lookup miss, the entire chain of potential resources can be loaded proactively. This strategy is efficient because it acknowledges that subsequent resource lookups within the same chain are likely to also result in misses, making a bulk load more performant than individual requests.
    
    Parameters:
    
    path - An array of Strings representing the lookup path elements for the L10nPack.
    
    index - An integer indicating the starting index within the path to begin the lookup. This is part of the optimization for minimizing roundtrips.
    
    localeName - A String representing the name of the locale for which the pack is being retrieved. If null, the default locale name retrieved via getDefaultLocaleName() is used.
    
    Returns:
    
    The assembled L10nPack containing localized entries, potentially aggregated from multiple providers, or null if no or only an empty entry exists in the passed path array at the passed index.
  - getPack
```
public static final L10nPack getPack(java.lang.String[] path,
                                     int index,
                                     java.lang.String localeName)
```
  - addPreloadL10nCacheFinishedListener
```
public static final void addPreloadL10nCacheFinishedListener(PreloadL10nCacheFinishedListenerI l)
```
  - preloadCache
```
public static final void preloadCache(L10nPackProviderI providerForPreloading,
                                      L10nPack[] packsToPreload,
                                      java.lang.String localeName)
```
  - recalcPath
```
public static final void recalcPath()
```
    Recalculates and updates the global lookup path for localization resources.
    This method collects all path entries from every registered localization pack provider. These collected paths are then ordered according to a defined precedence: first, ascending by their position, then alphabetically by the path string itself. Duplicate entries are filtered out along the way. The resulting global path is crucial for efficiently locating localization resources across the application.
  - flushCache
```
public static final void flushCache()
```
  - flushCache
```
public static final void flushCache(java.lang.String[] bundles)
```
  - flushCache
```
public static final void flushCache(java.lang.String bundle)
```
  - getL10nViaString
```
public java.lang.String getL10nViaString()
```
    Description copied from interface: L10nPackProviderI
    
    Provides a descriptive string indicating the means by which localization (L10n) data was delivered. This method is primarily for logging and debugging purposes. It helps identify the origin of the localized content. For instance, it might return strings like "DBMan", "Backend.L10nCache", "BackendConnection to MyTISM Backend", or "Classpath", specifying where the L10n resources were loaded from.
    
    Specified by:
    
    getL10nViaString in interface L10nPackProviderI
    
    Returns:
    
    A String describing the delivery mechanism or source of the L10n data.
  - getL10nPacks
```
public L10nPack[] getL10nPacks(java.lang.String[] bundles,
                               java.lang.String localeName)
```
    Description copied from interface: L10nPackProviderI
    
    Retrieves an array of L10nPack objects for multiple specified bundle names and a single locale.
    
    Specified by:
    
    getL10nPacks in interface L10nPackProviderI
    
    Parameters:
    
    bundles - An array of String names of the L10n bundles to retrieve.
    
    localeName - The name of the Locale for which to retrieve the packs.
    
    Returns:
    
    An array of L10nPacks corresponding to the requested bundle names, or an empty array if none are found.
  - getL10nPack
```
public L10nPack getL10nPack(java.lang.String name,
                            java.lang.String localeName)
```
    Description copied from interface: L10nPackProviderI
    
    Retrieves a specific L10nPack by its bundle name and locale.
    
    Specified by:
    
    getL10nPack in interface L10nPackProviderI
    
    Parameters:
    
    name - The name of the L10n bundle to retrieve.
    
    localeName - The name of the Locale for which to retrieve the pack.
    
    Returns:
    
    The requested L10nPack, or null if not found.
  - getL10nPath
```
public L10nPathEntry[] getL10nPath()
```
    Description copied from interface: L10nPackProviderI
    
    Retrieves the localization path entries provided by this pack provider.
    These path entries define the locations or priorities for searching localization resources within the overall L10n system.
    
    Specified by:
    
    getL10nPath in interface L10nPackProviderI
    
    Returns:
    
    An array of L10nPathEntry objects.
  - internalGetL10nPack
```
public L10nPack internalGetL10nPack(java.lang.String name,
                                    java.lang.String localeName)
```
    Loads L10nPack from *.properties file resources via classpath and getResourceAsStream().
  - prependPackProvider
```
public static final void prependPackProvider(L10nPackProviderI p)
```
  - appendPackProvider
```
public static final void appendPackProvider(L10nPackProviderI p)
```
  - removePackProvider
```
public static final void removePackProvider(L10nPackProviderI p)
```
  - addLocaleChangeListener
```
public static final void addLocaleChangeListener(L10nLocaleChangeListenerI _lcl)
```
  - setDefaultLocale
```
public static final void setDefaultLocale(java.util.Locale l)
```
    Sets the static default locale value for the L10n class as well as the default locale of the JVM. Warning: This will change the settings for the whole JVM and all threads; consider using setCurrentLocaleProvider() instead which will change the setting - for the L10n class only though - only for the calling thread.
  - setCurrentLocaleProvider
```
public static final void setCurrentLocaleProvider(L10nCurrentLocaleProviderI p)
```
    Sets the locale provider for the current Thread.
  - getCurrentLocaleProvider
```
public static final L10nCurrentLocaleProviderI getCurrentLocaleProvider()
```
    Gets the locale provider for the current Thread.
  - setLocaleForCurrentThread
```
public static final L10nCurrentLocaleProviderI setLocaleForCurrentThread(java.util.Locale locale)
```
    Convenience frontend for setCurrentLocaleProvider() which automatically wraps the given locale into a new SimpleL10nLocaleProvider and sets that. As with setCurrentLocaleProvider() remember to re-set the previous locale provider (possibly null in most cases) after the locale change is no longer required.
    
    Parameters:
    
    locale - the desired default locale for the current thread
    
    Returns:
    
    the possibly set previous L10nCurrentLocaleProviderI (or null, if none is set)
  - setLocaleNameForCurrentThread
```
public static final L10nCurrentLocaleProviderI setLocaleNameForCurrentThread(java.lang.String localeName)
```
  - getCurrentLocaleViaProvider
```
public static final java.util.Locale getCurrentLocaleViaProvider()
```
    Returns the current locale for the current Thread.
  - getDefaultLocale
```
public static final java.util.Locale getDefaultLocale()
```
  - setDefaultLocaleName
```
public static final void setDefaultLocaleName(java.lang.String s)
```
  - getDefaultLocaleName
```
public static final java.lang.String getDefaultLocaleName()
```
  - isParentOf
```
public static final boolean isParentOf(java.util.Locale supposedParent,
                                       java.util.Locale supposedChild)
```
  - getLocaleFromString
```
public static final java.util.Locale getLocaleFromString(java.lang.String s)
```
  - getDecimalFormat
```
public static final L10nDecimalFormat getDecimalFormat()
```
    Factory method to obtain locale-sensitive DecimalFormat objects.
    This method provides a flexible way to get a properly configured DecimalFormat instance. It supports custom patterns and locale settings, and includes caching for frequently requested formats based on the current default locale.
    
    Parameters:
    
    _pattern - The String pattern to use for formatting numbers (as specified in DecimalFormat JDK API documentation). If null, a standard pattern is constructed that matches locale settings but mimics a no-grouping, no-decimal-separator style on EN_US platforms.
    
    _locale - The designated Locale for this pattern. If null, the system's default locale is used. Note that if an explicit Locale is provided that differs from the current system default, caching for the generated DecimalFormat object will not be applied, leading to a new object creation on each call for such specific locales.
    
    Returns:
    
    A configured L10nDecimalFormat object matching the specified pattern and locale.
  - getDecimalFormat
```
public static final L10nDecimalFormat getDecimalFormat(java.lang.String _pattern)
```
  - getDecimalFormat
```
public static final L10nDecimalFormat getDecimalFormat(java.lang.String _pattern,
                                                       java.util.Locale _locale)
```
  - releaseDecimalFormat
```
public static final void releaseDecimalFormat(L10nDecimalFormat df)
```
    Releases a L10nDecimalFormat instance back to the cache for potential reuse.
    This method allows for the efficient management of L10nDecimalFormat objects by returning them to a pool or cache. The object is stored in the cache using its pattern as the key, and a condition (derived from L10nDecimalFormat::canBeCached and the locale) determines if it's eligible for caching.
    
    Parameters:
    
    df - The L10nDecimalFormat instance to release.
  - formatDecimal
```
public static final java.lang.String formatDecimal(java.lang.Number n)
```
  - formatDecimal
```
public static final java.lang.String formatDecimal(java.lang.Number n,
                                                   java.lang.String pattern)
```
  - formatDecimal
```
public static final java.lang.String formatDecimal(java.lang.Number n,
                                                   java.lang.String pattern,
                                                   java.util.Locale _locale)
```
  - formatDecimalNT
```
public static final java.lang.String formatDecimalNT(java.lang.Number n,
                                                     java.lang.String pattern,
                                                     java.lang.String fallback)
```
    null safe version of formatDecimal with fallback if number is null
  - formatDecimalNT
```
public static final java.lang.String formatDecimalNT(java.lang.Number n)
```
    null safe version of formatDecimal with fallback if number is null
  - formatDecimalNT
```
public static final java.lang.String formatDecimalNT(java.lang.Number n,
                                                     java.lang.String pattern)
```
  - formatDecimalNT
```
public static final java.lang.String formatDecimalNT(java.lang.Number n,
                                                     java.lang.String pattern,
                                                     java.util.Locale locale)
```
  - formatDecimalNT
```
public static final java.lang.String formatDecimalNT(java.lang.Number n,
                                                     java.lang.String pattern,
                                                     java.util.Locale locale,
                                                     java.lang.String fallback)
```
  - parseDecimal
```
public static final java.math.BigDecimal parseDecimal(java.lang.String s)
                                               throws java.text.ParseException
```
    Method to parse a L10n formatted Number in a String to the represented BigDecimal value.
    
    Parameters:
    
    s - the input string to parse
    
    pattern - FIXME link to pattern description
    
    _local - the locale of the source string, e.g. GERMAN for 12,3 or US for 12.3
    
    Returns:
    
    a bigdecimal with the value provided in the string s
    
    Throws:
    
    java.text.ParseException
  - parseDecimal
```
public static final java.math.BigDecimal parseDecimal(java.lang.String s,
                                                      java.lang.String pattern)
                                               throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseDecimal
```
public static final java.math.BigDecimal parseDecimal(java.lang.String s,
                                                      java.lang.String pattern,
                                                      java.util.Locale _locale)
                                               throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseDecimal
```
public static final java.math.BigDecimal parseDecimal(java.lang.String s,
                                                      java.lang.String[] patterns)
                                               throws MultipleParseException
```
    Throws:
    
    MultipleParseException
  - parseDecimal
```
public static final java.math.BigDecimal parseDecimal(java.lang.String s,
                                                      java.lang.String[] patterns,
                                                      java.util.Locale _locale)
                                               throws MultipleParseException
```
    Throws:
    
    MultipleParseException
  - parseDecimalNT
```
public static final java.math.BigDecimal parseDecimalNT(java.lang.String s)
```
    wrapper for parseDecimal that throws no exception. if an exception is caught, fallback is returned, which defaults to null
  - parseDecimalNT
```
public static final java.math.BigDecimal parseDecimalNT(java.lang.String s,
                                                        java.lang.String pattern)
```
  - parseDecimalNT
```
public static final java.math.BigDecimal parseDecimalNT(java.lang.String s,
                                                        java.lang.String pattern,
                                                        java.math.BigDecimal fallback)
```
  - parseDecimalNT
```
public static final java.math.BigDecimal parseDecimalNT(java.lang.String s,
                                                        java.lang.String[] patterns)
```
    wrapper for parseDecimal that throws no exception. if an exception is caught, fallback is returned, which defaults to null
  - parseDecimalNT
```
public static final java.math.BigDecimal parseDecimalNT(java.lang.String s,
                                                        java.lang.String[] patterns,
                                                        java.math.BigDecimal fallback)
```
  - getDateFormat
```
public static final L10nDateFormat getDateFormat()
```
  - getDateFormat
```
public static final L10nDateFormat getDateFormat(java.lang.String _pattern)
```
  - getDateFormat
```
public static final L10nDateFormat getDateFormat(java.lang.String _pattern,
                                                 java.util.Locale _locale)
```
  - getDateFormat
```
public static final L10nDateFormat getDateFormat(java.lang.String _pattern,
                                                 java.util.Locale _locale,
                                                 java.util.TimeZone timeZone)
```
  - releaseDateFormat
```
public static final void releaseDateFormat(L10nDateFormat df)
```
  - formatDate
```
public static final java.lang.String formatDate(java.util.Date d)
```
    usage with locale not recommended as they are not being cached, which leads to poor performance. the locale can instead be stored in the pattern-string
  - formatDate
```
public static final java.lang.String formatDate(java.util.Date d,
                                                java.lang.String pattern)
```
  - formatDate
```
public static final java.lang.String formatDate(java.util.Date d,
                                                java.lang.String pattern,
                                                java.util.Locale _locale)
```
  - formatDate
```
public static final java.lang.String formatDate(java.util.Date d,
                                                java.lang.String pattern,
                                                java.util.Locale _locale,
                                                java.util.TimeZone timeZone)
```
  - formatDateNT
```
public static final java.lang.String formatDateNT(java.util.Date d,
                                                  java.lang.String pattern,
                                                  java.lang.String fallback)
```
    null safe version of formatDate with fallback if date is null
  - formatDateNT
```
public static final java.lang.String formatDateNT(java.util.Date d)
```
    null safe version of formatDate with fallback if date is null
  - formatDateNT
```
public static final java.lang.String formatDateNT(java.util.Date d,
                                                  java.lang.String pattern)
```
  - formatDateNT
```
public static final java.lang.String formatDateNT(java.util.Date d,
                                                  java.lang.String pattern,
                                                  java.util.Locale locale)
```
  - formatDateNT
```
public static final java.lang.String formatDateNT(java.util.Date d,
                                                  java.lang.String pattern,
                                                  java.util.Locale locale,
                                                  java.lang.String fallback)
```
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s)
                                      throws java.text.ParseException
```
    usage with locale not recommended as they are not being cached, which leads to poor performance. the locale can instead be stored in the pattern-string
    
    Throws:
    
    java.text.ParseException
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s,
                                             java.lang.String pattern)
                                      throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s,
                                             java.lang.String pattern,
                                             java.util.Locale _locale)
                                      throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s,
                                             java.lang.String pattern,
                                             java.util.Locale _locale,
                                             java.util.TimeZone timeZone)
                                      throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseDateNT
```
public static final java.util.Date parseDateNT(java.lang.String s)
```
    wrapper for parseDate that throws no exception. if an exception is caught, fallback is returned, which defaults to null
  - parseDateNT
```
public static final java.util.Date parseDateNT(java.lang.String s,
                                               java.lang.String pattern)
```
  - parseDateNT
```
public static final java.util.Date parseDateNT(java.lang.String s,
                                               java.lang.String pattern,
                                               java.util.Date fallback)
```
  - parseDateNT
```
public static final java.util.Date parseDateNT(java.lang.String s,
                                               java.lang.String[] patterns)
```
    wrapper for parseDate that throws no exception. if an exception is caught, fallback is returned, which defaults to null
  - parseDateNT
```
public static final java.util.Date parseDateNT(java.lang.String s,
                                               java.lang.String[] patterns,
                                               java.util.Date fallback)
```
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s,
                                             java.lang.String[] patterns)
                                      throws MultipleParseException
```
    usage with locale not recommended as they are not being cached which leads to poor performance. the locale can instead be stored in the pattern-string
    
    Throws:
    
    MultipleParseException
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s,
                                             java.lang.String[] patterns,
                                             java.util.Locale _locale)
                                      throws MultipleParseException
```
    Throws:
    
    MultipleParseException
  - parseDate
```
public static final java.util.Date parseDate(java.lang.String s,
                                             java.lang.String[] patterns,
                                             java.util.Locale _locale,
                                             java.util.TimeZone timeZone)
                                      throws MultipleParseException
```
    Throws:
    
    MultipleParseException
  - parseISO8601
```
public static final java.util.Date parseISO8601(java.lang.String s)
                                         throws java.time.format.DateTimeParseException
```
    Parses an ISO8601:2019 conform Datetime text, returning the parameter as Date. See java.time.OffsetDateTime#parse(String). Expected formats are yyyy-MM-dd'T'HH:mm:ss.SSSX or yyyy-MM-dd'T'HH:mm:ssX The resolution of the result will be limited by the maximum resolution possible of Date, i.e. milliseconds. Nanosecond information of the input will be ignored.
    
    Parameters:
    
    s - an ISO conformant String, not null.
    
    Returns:
    
    a nonnull Date that represents the same point in time as the parameter.
    
    Throws:
    
    java.time.format.DateTimeParseException
  - parseISO8601NT
```
public static final java.util.Date parseISO8601NT(java.lang.String s)
```
    Non-throw version of parseISO8601(String), returning the fallback if the given String is not a valid ISO date
  - parseISO8601NT
```
public static final java.util.Date parseISO8601NT(java.lang.String s,
                                                  java.util.Date fallback)
```
  - parseISODate
```
public static final java.util.Date parseISODate(java.lang.String s)
                                         throws MultipleParseException
```
    Parses the given parameter as a ISO8601 like date, e.g. yyyy-MM-dd'T'HH:mm:ss.SSSX or yyyy-MM-dd, while trying to be a bit more tolerant regarding formatting errors. Please note that this might cause unexpected results. If the input does not declare a timezone, then the default timezone of the running JVM is used. This can cause the same input to represent a different points in time for different clients/servers. The resolution of the parseable string is limited to milliseconds. Nanosecond information of the input will interpreted as milliseconds.
    
    Parameters:
    
    s - the date(time) to parse, nonnull.
    
    Returns:
    
    the parsed input as Date, nonnull.
    
    Throws:
    
    MultipleParseException
  - parseISODateNT
```
public static final java.util.Date parseISODateNT(java.lang.String s)
```
    wrapper for parseISODate thet throws no exception. if an exception is caught, fallback is returned, which defaults to null
  - parseISODateNT
```
public static final java.util.Date parseISODateNT(java.lang.String s,
                                                  java.util.Date fallback)
```
  - formatISODate
```
public static final java.lang.String formatISODate(java.util.Date d)
```
    Formats the given Date in ISO8601 like format, with the 'T' replaced by a space.
  - formatISODateNT
```
public static final java.lang.String formatISODateNT(java.util.Date d)
```
    null safe version of formatISODate with fallback if date is null
  - formatISODateNT
```
public static final java.lang.String formatISODateNT(java.util.Date d,
                                                     java.lang.String fallback)
```
  - formatISO8601
```
public static final java.lang.String formatISO8601(java.util.Date date)
```
    Returns the given Date in an ISO8601:2019 conformant String. Can be parsed by parseISO8601(String). e.g. 2021-02-25T14:15:00.001Z or 2021-02-25T15:15:00.001+01:00
    
    Parameters:
    
    date - the date to format, not null.
    
    withLocalTimeZone - defaults to false, which will return the date in Zulu time, aka GMT+0. If true, the current default timezone is used to format the date. The represented point in time will be identical in either case.
    
    Returns:
    
    the provided Date in an ISO8601 conform string including timezone.
    
    See Also:
    
    OffsetDateTime.ofInstant(Instant, ZoneId)
  - formatISO8601
```
public static final java.lang.String formatISO8601(java.util.Date date,
                                                   boolean withLocalTimeZone)
```
  - formatISO8601NT
```
public static final java.lang.String formatISO8601NT(java.util.Date date)
```
    Not throwing version of #formatISO8601Date(Date, boolean). Defaults to the empty String on error.
  - formatISO8601NT
```
public static final java.lang.String formatISO8601NT(java.util.Date date,
                                                     java.lang.String fallback)
```
  - formatISO8601NT
```
public static final java.lang.String formatISO8601NT(java.util.Date date,
                                                     java.lang.String fallback,
                                                     boolean withLocalTimeZone)
```
  - getTimespanFormat
```
public static final L10nTimespanFormat getTimespanFormat()
```
  - getTimespanFormat
```
public static final L10nTimespanFormat getTimespanFormat(java.lang.String pattern)
```
  - getTimespanFormat
```
public static final L10nTimespanFormat getTimespanFormat(java.lang.String pattern,
                                                         java.util.Locale locale)
```
  - releaseTimespanFormat
```
public static final void releaseTimespanFormat(L10nTimespanFormat df)
```
  - formatTimespan
```
public static final java.lang.String formatTimespan(java.lang.Number _ts)
```
    Parameters:
    
    _ts - timespan in milliseconds
  - formatTimespan
```
public static final java.lang.String formatTimespan(java.lang.Number _ts,
                                                    java.lang.String _pattern)
```
  - formatTimespan
```
public static final java.lang.String formatTimespan(java.lang.Number _ts,
                                                    java.lang.String _pattern,
                                                    java.util.Locale _locale)
```
  - parseTimespan
```
public static final java.lang.Long parseTimespan(java.lang.String _str)
                                          throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseTimespan
```
public static final java.lang.Long parseTimespan(java.lang.String _str,
                                                 java.lang.String _pattern)
                                          throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseTimespan
```
public static final java.lang.Long parseTimespan(java.lang.String _str,
                                                 java.lang.String _pattern,
                                                 java.util.Locale _locale)
                                          throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - parseTimespan
```
public static final java.lang.Long parseTimespan(java.lang.String _str,
                                                 java.lang.String[] _patterns)
                                          throws MultipleParseException
```
    Throws:
    
    MultipleParseException
  - parseTimespan
```
public static final java.lang.Long parseTimespan(java.lang.String _str,
                                                 java.lang.String[] _patterns,
                                                 java.util.Locale _locale)
                                          throws MultipleParseException
```
    Throws:
    
    MultipleParseException
  - formatDuration
```
public static final java.lang.String formatDuration(javax.xml.datatype.Duration _dur)
```
  - formatDuration
```
public static final java.lang.String formatDuration(javax.xml.datatype.Duration _dur,
                                                    java.lang.String _pattern)
```
  - formatDuration
```
public static final java.lang.String formatDuration(javax.xml.datatype.Duration _dur,
                                                    java.lang.String _pattern,
                                                    java.util.Locale _locale)
```
  - parseDuration
```
public static final javax.xml.datatype.Duration parseDuration(java.lang.String s)
```
  - getWaehrungsSymbol
```
public static final java.lang.String getWaehrungsSymbol(java.lang.String isocode)
```
  - getCollator
```
public static final java.text.Collator getCollator()
```
    returns a Collator for the current default locale, but makes it space sensitive
  - getCollator
```
public static final java.text.Collator getCollator(java.util.Locale l)
```
  - getCollator
```
public static final java.text.Collator getCollator(java.util.Locale l,
                                                   java.lang.String parms)
```
  - splitPath
```
public static final java.lang.String[] splitPath(java.lang.String _path)
```
    Splits the given _path on '/' but ignoring '/' insided of $R{...} tags.
  - getLanguageSeperatedByDash
```
public static final java.lang.String getLanguageSeperatedByDash(java.lang.String _str,
                                                                int _lang)
```
    this method takes a String where the languages are seperated by | it returns the _lang'th language of this string, beginning at 1

Class L10n

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.ipcon.tools.L10nPackProviderI

Field Detail

validPackagePattern

validBundleNamePattern

validResourceKeyChars

validResourceKeyPattern

l10nTagPattern

PACK_SEPARATOR

defaultLocaleLock

Method Detail

activateCompilePathDebugging

deactivateCompilePathDebugging

isCompilePathDebuggingActive

logCompiledPath

activateMsgDebugging

activateMsgDebugging

deactivateMsgDebugging

isMsgDebuggingActive

getMsgDebuggingActiveForKey

logMsg

activateValidPackDebugging

activateValidPackDebugging

deactivateValidPackDebugging

isValidPackDebuggingActive

getValidPackDebuggingActiveForKey

logValidPack

applyL10nLocale

applyL10n

applyL10n

applyL10n

applyL10n

applyL10n

applyL10n

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msgNoKey

msgNoKey

msgNoKey

msg

msg

msg

msg

msg

msg

msg

msg

msgNoFormat

msgNoFormat

msgNoFormat

msgNoFormat

resolveLater

resolveLater

resolveLater

validPack

validPack

getAutoPath

getAutoPath

getGetCallingClassNameImplementation

stringToKey

stringToKey

compilePath

canonifyPackageName

addPathCompilerForClass

removePathCompilerForClass

firePathCompilersChanged