public class BundleUtil
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
protected class |
BundleUtil.BundleGroupClassLoader
BundleUtil.BundleGroupClassLoader exists so that getResource*() calls can be intercepted and directed to
getLangPackLoader() and the wrapped ClassLoader before going to the system ClassLoader
if necessary. |
protected class |
BundleUtil.KeyTracker |
Modifier and Type | Field and Description |
---|---|
protected java.lang.ClassLoader |
baseLoader |
protected com.inductiveautomation.ignition.common.BundleUtil.BundleGroup |
commonGroup |
protected java.lang.ClassLoader |
langPackLoader |
protected org.apache.log4j.Logger |
log |
protected java.util.List<com.inductiveautomation.ignition.common.BundleUtil.ReplaceToken> |
replacements |
protected java.util.concurrent.ConcurrentMap<java.lang.String,com.inductiveautomation.ignition.common.BundleUtil.BundleGroup> |
subGroups |
protected java.util.Map<java.lang.String,Version> |
versionCache |
Modifier and Type | Method and Description |
---|---|
void |
addBundle(java.lang.Class<?> clazz)
Shortcut for adding a resource bundle for a specific class whose prefix is the simple classname.
|
void |
addBundle(java.lang.String prefix,
java.lang.Class<?> clazz,
java.lang.String bundleName)
Adds a bundle that is located next to a class with a custom prefix.
|
void |
addBundle(java.lang.String prefix,
java.lang.ClassLoader owner,
java.lang.String bundleName)
Adds a new prefixed sub-bundle with the given classloader.
|
void |
addCommonBundle(java.lang.String bundleName)
Adds a new bundle to the common (non-prefixed) bundle.
|
void |
addExternalLookupLocations(java.util.List<java.net.URL> locations)
Registers locations that will be consulted for translation packs.
|
void |
addReplacement(java.lang.String key,
java.lang.String value)
Adds a new key, value pair that will be used as a replacement token for all bundle strings.
|
void |
addSupportedLocales(java.util.Collection<java.util.Locale> locales) |
protected java.lang.String |
applyReplacements(java.lang.String source) |
static BundleUtil |
get() |
boolean |
getBoolean(java.lang.String keyName) |
java.lang.String |
getClientName() |
java.awt.Color |
getColor(java.lang.String keyName,
java.awt.Color defaultColor) |
java.lang.String |
getCompanyName() |
java.lang.String |
getDefinedString(java.util.Locale locale,
java.lang.String keyName)
Returns the raw translated text, after replacements have been made, but without applying any formatting values.
|
java.lang.String |
getDesignerName() |
java.lang.String |
getGatewayName() |
int |
getInt(java.lang.String keyName) |
java.lang.ClassLoader |
getLangPackLoader() |
char |
getMnemonic(java.lang.String keyName,
char fallBack)
Returns a single char that defines a keyboard shortcut, defined in an externalized file.
|
java.lang.String |
getPlatformName() |
Version |
getPlatformVersion() |
java.lang.String |
getPlatformVersionString() |
protected java.lang.String |
getRawString(java.util.Locale locale,
java.lang.String key)
Looks up the raw key from the local resource bundles.
|
java.lang.String |
getString(java.util.Locale locale,
java.lang.String keyName) |
java.lang.String |
getString(java.util.Locale locale,
java.lang.String keyName,
java.lang.Object... formatArgs) |
java.lang.String |
getString(java.lang.String keyName)
Looks up the resource string associated with the given keyname.
|
java.lang.String |
getString(java.lang.String keyName,
java.lang.Object... formatArgs) |
java.lang.String |
getStringLenient(java.util.Locale locale,
java.lang.String keyName,
java.lang.Object... formatArgs) |
java.lang.String |
getStringLenient(java.lang.String keyName)
Returns the resource string associated with the given keyname, if any.
|
java.lang.String |
getStringLenient(java.lang.String keyName,
java.lang.Object... formatArgs) |
java.util.List<java.util.Locale> |
getSupportedLocales()
Provides a list of the locales that are currently supported/choosable.
|
Version |
getVersion(java.lang.String prefix)
Shortcut for creating a Version from property resources.
|
java.lang.String |
getVersionString(java.lang.String module)
Returns the full version string, like "3.1.1 (build 1557)"
|
java.lang.String |
getVersionStringShort(java.lang.String module)
Returns the version string like 1.5.2
|
static java.lang.String |
i18n(java.util.Locale locale,
java.lang.String key,
java.lang.Object... args) |
static java.lang.String |
i18n(java.lang.String key,
java.lang.Object... args)
Static shorthand for BundleUtil.get().getStringLenient(key, args)
|
boolean |
isKeyPresent(java.lang.String keyName) |
static boolean |
isWhiteLabeled()
Tests to see if this is a white-labeled build of Ignition
|
protected void |
refreshClassLoaders() |
void |
registerBaseClassLoader(java.lang.ClassLoader loader) |
void |
removeBundle(java.lang.Class<?> clazz)
Equiv to removeBundle(clazz.getSimpleName(), clazz.getName().replace('.', '/'));
|
void |
removeBundle(java.lang.String prefix)
Removes all bundles added under the given prefix
|
void |
removeBundle(java.lang.String prefix,
java.lang.String bundleName)
Removes all the specific bundle that was added under the given prefix and the given bundle name.
|
boolean |
removeReplacement(java.lang.String key)
Removes the replacement with this key.
|
protected void |
updateLanguagePackLoader(java.lang.ClassLoader loader) |
protected java.lang.ClassLoader baseLoader
protected java.lang.ClassLoader langPackLoader
protected com.inductiveautomation.ignition.common.BundleUtil.BundleGroup commonGroup
protected java.util.concurrent.ConcurrentMap<java.lang.String,com.inductiveautomation.ignition.common.BundleUtil.BundleGroup> subGroups
protected java.util.List<com.inductiveautomation.ignition.common.BundleUtil.ReplaceToken> replacements
protected java.util.Map<java.lang.String,Version> versionCache
protected org.apache.log4j.Logger log
public static BundleUtil get()
public static java.lang.String i18n(java.lang.String key, java.lang.Object... args)
public static java.lang.String i18n(java.util.Locale locale, java.lang.String key, java.lang.Object... args)
public static boolean isWhiteLabeled()
public void addExternalLookupLocations(java.util.List<java.net.URL> locations)
protected void refreshClassLoaders()
protected void updateLanguagePackLoader(java.lang.ClassLoader loader)
public void registerBaseClassLoader(java.lang.ClassLoader loader)
public java.util.List<java.util.Locale> getSupportedLocales()
public void addSupportedLocales(java.util.Collection<java.util.Locale> locales)
public java.lang.ClassLoader getLangPackLoader()
public void addReplacement(java.lang.String key, java.lang.String value)
public boolean removeReplacement(java.lang.String key)
public void addBundle(java.lang.String prefix, java.lang.ClassLoader owner, java.lang.String bundleName)
Confirm=Are You Sure HelpText=Eek!And you add the bundle like:
addBundle("MyModule", loader, "com/acme/product/PropFile");Then you'd get the key like this:
BundleUtil.get().getString("MyModule.Confirm");
public void removeBundle(java.lang.Class<?> clazz)
public void removeBundle(java.lang.String prefix)
public void removeBundle(java.lang.String prefix, java.lang.String bundleName)
public void addBundle(java.lang.Class<?> clazz)
addBundle(clazz.getSimpleName(), clazz.getClassLoader(), clazz.getName().replace('.', '/'));
public void addBundle(java.lang.String prefix, java.lang.Class<?> clazz, java.lang.String bundleName)
public void addCommonBundle(java.lang.String bundleName)
public char getMnemonic(java.lang.String keyName, char fallBack)
public java.lang.String getStringLenient(java.lang.String keyName)
public java.lang.String getStringLenient(java.lang.String keyName, java.lang.Object... formatArgs)
public java.lang.String getStringLenient(java.util.Locale locale, java.lang.String keyName, java.lang.Object... formatArgs)
public java.lang.String getString(java.lang.String keyName)
public java.lang.String getString(java.lang.String keyName, java.lang.Object... formatArgs)
public java.lang.String getString(java.util.Locale locale, java.lang.String keyName)
public java.lang.String getString(java.util.Locale locale, java.lang.String keyName, java.lang.Object... formatArgs)
public java.lang.String getDefinedString(java.util.Locale locale, java.lang.String keyName)
public boolean isKeyPresent(java.lang.String keyName)
protected java.lang.String getRawString(java.util.Locale locale, java.lang.String key)
protected java.lang.String applyReplacements(java.lang.String source)
public java.awt.Color getColor(java.lang.String keyName, java.awt.Color defaultColor)
public boolean getBoolean(java.lang.String keyName)
public int getInt(java.lang.String keyName)
public java.lang.String getCompanyName()
public java.lang.String getGatewayName()
public java.lang.String getClientName()
public java.lang.String getDesignerName()
public java.lang.String getPlatformName()
public Version getVersion(java.lang.String prefix)
Version.parse(String)
public Version getPlatformVersion()
public java.lang.String getPlatformVersionString()
public java.lang.String getVersionString(java.lang.String module)
public java.lang.String getVersionStringShort(java.lang.String module)