Class UResourceBundle
A class representing a collection of resource information pertaining to a given locale. A resource bundle provides a way of accessing locale- specific information in a data file. You create a resource bundle that manages the resources for a given locale and then ask it for individual resources.
In ResourceBundle, an object is created and the sub-items are fetched using the getString and getObject methods. In UResourceBundle, each individual element of a resource is a resource by itself.
Resource bundles in ICU are currently defined using text files that conform to the following BNF definition. More on resource bundle concepts and syntax can be found in the Users Guide.
The packaging of ICU *.res files can be of two types ICU4C:
root.res | -------- | | fr.res en.res | -------- | | fr_CA.res fr_FR.resJAVA/JDK:
LocaleElements.res | ------------------- | | LocaleElements_fr.res LocaleElements_en.res | --------------------------- | | LocaleElements_fr_CA.res LocaleElements_fr_FR.resDepending on the organization of your resources, the syntax to getBundleInstance will change. To open ICU style organization use:
UResourceBundle bundle = UResourceBundle.getBundleInstance("com/mycompany/resources", "en_US", myClassLoader);To open Java/JDK style organization use:
UResourceBundle bundle = UResourceBundle.getBundleInstance("com.mycompany.resources.LocaleElements", "en_US", myClassLoader);
Note: Please use pass a class loader for loading non-ICU resources. Java security does not allow loading of resources across jar files. You must provide your class loader to load the resources
- Author:
- ram
-
Nested Class Summary
Nested classes/interfaces inherited from class java.util.ResourceBundle
ResourceBundle.Control
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Resource type constant for arrays of resources.static final int
Resource type constant for binary data.static final int
Resource type constant for a single 28-bit integer, interpreted as signed or unsigned by the getInt() function.static final int
Resource type constant for vectors of 32-bit integers.static final int
Resource type constant for "no resource".static final int
Resource type constant for strings.static final int
Resource type constant for tables of key-value pairs.Fields inherited from class java.util.ResourceBundle
parent
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected UResourceBundle
findTopLevel
(int index) Deprecated.This API is ICU internal only.protected UResourceBundle
findTopLevel
(String aKey) Deprecated.This API is ICU internal only.get
(int index) Returns the resource in a given resource at the specified index.Returns a resource in a given resource that has a given key.protected abstract String
Returns the base name of the resource bundleReturns a binary data item from a binary resource, as a read-only ByteBuffer.byte[]
getBinary
(byte[] ba) Returns a binary data from a binary resource, as a byte array with a copy of the bytes from the resource bundle.static UResourceBundle
getBundleInstance
(ULocale locale) Creates a UResourceBundle for the locale specified, from which users can extract resources by using their corresponding keys.static UResourceBundle
getBundleInstance
(String baseName) Creates a UResourceBundle for the default locale and specified base name, from which users can extract resources by using their corresponding keys.static UResourceBundle
getBundleInstance
(String baseName, ULocale locale) Creates a UResourceBundle, from which users can extract resources by using their corresponding keys.static UResourceBundle
getBundleInstance
(String baseName, ULocale locale, ClassLoader loader) Creates a UResourceBundle, from which users can extract resources by using their corresponding keys.
Note: Please use this API for loading non-ICU resources.static UResourceBundle
getBundleInstance
(String baseName, String localeName) Creates a resource bundle using the specified base name and locale.static UResourceBundle
getBundleInstance
(String baseName, String localeName, ClassLoader root) Creates a resource bundle using the specified base name, locale, and class root.protected static UResourceBundle
getBundleInstance
(String baseName, String localeName, ClassLoader root, boolean disableFallback) Creates a resource bundle using the specified base name, locale, and class root.static UResourceBundle
getBundleInstance
(String baseName, Locale locale) Creates a UResourceBundle for the specified locale and specified base name, from which users can extract resources by using their corresponding keys.static UResourceBundle
getBundleInstance
(String baseName, Locale locale, ClassLoader loader) Creates a UResourceBundle for the specified locale and specified base name, from which users can extract resources by using their corresponding keys.int
getInt()
Returns a signed integer from a resource.int[]
Returns a 32 bit integer array from a resource.Returns the iterator which iterates over this resource bundlegetKey()
Returns the key associated with a given resource.getKeys()
Returns the keys in this bundle as an enumerationReturns the locale of this bundleprotected abstract String
Returns the localeIDprotected abstract UResourceBundle
Returns the parent bundleint
getSize()
Returns the size of a resource.Returns a string from a string resource typegetString
(int index) Returns the string in a given resource at the specified index.String[]
Returns a string array from a array resource typeint
getType()
Returns the type of a resource.int
getUInt()
Returns a unsigned integer from a resource.abstract ULocale
Returns the RFC 3066 conformant locale id of this resource bundle.Return the version number associated with this UResourceBundle as an VersionInfo object.protected UResourceBundle
handleGet
(int index, HashMap<String, String> aliasesVisited, UResourceBundle requested) Actual worker method for fetching a resource based on the given index.protected UResourceBundle
Actual worker method for fetching a resource based on the given key.protected Enumeration
<String> Actual worker method for fetching the keys of resources contained in the resource.protected Object
handleGetObject
(String aKey) protected String[]
Actual worker method for fetching the array of strings in a resource.Deprecated.This API is ICU internal only.protected static UResourceBundle
instantiateBundle
(String baseName, String localeName, ClassLoader root, boolean disableFallback) Loads a new resource bundle for the given base name, locale and class loader.protected boolean
Deprecated.This API is ICU internal only.keySet()
Deprecated.This API is ICU internal only.Methods inherited from class java.util.ResourceBundle
clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getObject, getString, getStringArray, setParent
-
Field Details
-
NONE
public static final int NONEResource type constant for "no resource".- See Also:
-
STRING
public static final int STRINGResource type constant for strings.- See Also:
-
BINARY
public static final int BINARYResource type constant for binary data.- See Also:
-
TABLE
public static final int TABLEResource type constant for tables of key-value pairs.- See Also:
-
INT
public static final int INTResource type constant for a single 28-bit integer, interpreted as signed or unsigned by the getInt() function.- See Also:
-
ARRAY
public static final int ARRAYResource type constant for arrays of resources.- See Also:
-
INT_VECTOR
public static final int INT_VECTORResource type constant for vectors of 32-bit integers.- See Also:
-
-
Constructor Details
-
UResourceBundle
public UResourceBundle()Sole constructor. (For invocation by subclass constructors, typically implicit.) This is public for compatibility with Java, whose compiler will generate public default constructors for an abstract class.
-
-
Method Details
-
getBundleInstance
Creates a resource bundle using the specified base name and locale. ICU_DATA_CLASS is used as the default root.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.localeName
- the locale for which a resource bundle is desired- Returns:
- a resource bundle for the given base name and locale
- Throws:
MissingResourceException
- If no resource bundle for the specified base name can be found
-
getBundleInstance
public static UResourceBundle getBundleInstance(String baseName, String localeName, ClassLoader root) Creates a resource bundle using the specified base name, locale, and class root.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.localeName
- the locale for which a resource bundle is desiredroot
- the class object from which to load the resource bundle- Returns:
- a resource bundle for the given base name and locale
- Throws:
MissingResourceException
- If no resource bundle for the specified base name can be found
-
getBundleInstance
protected static UResourceBundle getBundleInstance(String baseName, String localeName, ClassLoader root, boolean disableFallback) Creates a resource bundle using the specified base name, locale, and class root.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.localeName
- the locale for which a resource bundle is desiredroot
- the class object from which to load the resource bundledisableFallback
- Option to disable locale inheritance. If true the fallback chain will not be built.- Returns:
- a resource bundle for the given base name and locale
- Throws:
MissingResourceException
- if no resource bundle for the specified base name can be found
-
getBundleInstance
Creates a UResourceBundle for the locale specified, from which users can extract resources by using their corresponding keys.- Parameters:
locale
- specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.- Returns:
- a resource bundle for the given locale
-
getBundleInstance
Creates a UResourceBundle for the default locale and specified base name, from which users can extract resources by using their corresponding keys.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.- Returns:
- a resource bundle for the given base name and default locale
-
getBundleInstance
Creates a UResourceBundle for the specified locale and specified base name, from which users can extract resources by using their corresponding keys.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.locale
- specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.- Returns:
- a resource bundle for the given base name and locale
-
getBundleInstance
Creates a UResourceBundle, from which users can extract resources by using their corresponding keys.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.locale
- specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.- Returns:
- a resource bundle for the given base name and locale
-
getBundleInstance
Creates a UResourceBundle for the specified locale and specified base name, from which users can extract resources by using their corresponding keys.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.locale
- specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.loader
- the loader to use- Returns:
- a resource bundle for the given base name and locale
-
getBundleInstance
public static UResourceBundle getBundleInstance(String baseName, ULocale locale, ClassLoader loader) Creates a UResourceBundle, from which users can extract resources by using their corresponding keys.
Note: Please use this API for loading non-ICU resources. Java security does not allow loading of resources across jar files. You must provide your class loader to load the resources- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.locale
- specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.loader
- the loader to use- Returns:
- a resource bundle for the given base name and locale
-
getULocale
Returns the RFC 3066 conformant locale id of this resource bundle. This method can be used after a call to getBundleInstance() to determine whether the resource bundle returned really corresponds to the requested locale or is a fallback.- Returns:
- the locale of this resource bundle
-
getLocaleID
Returns the localeID- Returns:
- The string representation of the localeID
-
getBaseName
Returns the base name of the resource bundle- Returns:
- The string representation of the base name
-
getParent
Returns the parent bundle- Returns:
- The parent bundle
-
getLocale
Returns the locale of this bundle- Overrides:
getLocale
in classResourceBundle
- Returns:
- the locale of this resource bundle
-
instantiateBundle
protected static UResourceBundle instantiateBundle(String baseName, String localeName, ClassLoader root, boolean disableFallback) Loads a new resource bundle for the given base name, locale and class loader. Optionally will disable loading of fallback bundles.- Parameters:
baseName
- string containing the name of the data package. If null the default ICU package name is used.localeName
- the locale for which a resource bundle is desiredroot
- the class object from which to load the resource bundledisableFallback
- disables loading of fallback lookup chain- Returns:
- a resource bundle for the given base name and locale
- Throws:
MissingResourceException
- If no resource bundle for the specified base name can be found
-
getBinary
Returns a binary data item from a binary resource, as a read-only ByteBuffer.- Returns:
- a pointer to a chunk of unsigned bytes which live in a memory mapped/DLL file.
- Throws:
MissingResourceException
- If no resource bundle can be found.UResourceTypeMismatchException
- If the resource has a type mismatch.- See Also:
-
getString
Returns a string from a string resource type- Returns:
- a string
- Throws:
MissingResourceException
- If resource bundle is missing.UResourceTypeMismatchException
- If resource bundle has a type mismatch.- See Also:
-
getStringArray
Returns a string array from a array resource type- Returns:
- a string
- Throws:
MissingResourceException
- If resource bundle is missing.UResourceTypeMismatchException
- If resource bundle has a type mismatch.- See Also:
-
getBinary
public byte[] getBinary(byte[] ba) Returns a binary data from a binary resource, as a byte array with a copy of the bytes from the resource bundle.- Parameters:
ba
- The byte array to write the bytes to. A null variable is OK.- Returns:
- an array of bytes containing the binary data from the resource.
- Throws:
MissingResourceException
- If resource bundle is missing.UResourceTypeMismatchException
- If resource bundle has a type mismatch.- See Also:
-
getIntVector
public int[] getIntVector()Returns a 32 bit integer array from a resource.- Returns:
- a pointer to a chunk of unsigned bytes which live in a memory mapped/DLL file.
- Throws:
MissingResourceException
- If resource bundle is missing.UResourceTypeMismatchException
- If resource bundle has a type mismatch.- See Also:
-
getInt
public int getInt()Returns a signed integer from a resource.- Returns:
- an integer value
- Throws:
MissingResourceException
- If resource bundle is missing.UResourceTypeMismatchException
- If resource bundle type mismatch.- See Also:
-
getUInt
public int getUInt()Returns a unsigned integer from a resource. This integer is originally 28 bit and the sign gets propagated.- Returns:
- an integer value
- Throws:
MissingResourceException
- If resource bundle is missing.UResourceTypeMismatchException
- If resource bundle type mismatch.- See Also:
-
get
Returns a resource in a given resource that has a given key.- Parameters:
aKey
- a key associated with the wanted resource- Returns:
- a resource bundle object representing the resource
- Throws:
MissingResourceException
- If resource bundle is missing.
-
findTopLevel
Deprecated.This API is ICU internal only.Returns a resource in a given resource that has a given key, or null if the resource is not found.- Parameters:
aKey
- the key associated with the wanted resource- Returns:
- the resource, or null
- See Also:
-
getString
Returns the string in a given resource at the specified index.- Parameters:
index
- an index to the wanted string.- Returns:
- a string which lives in the resource.
- Throws:
IndexOutOfBoundsException
- If the index value is out of bounds of accepted values.UResourceTypeMismatchException
- If resource bundle type mismatch.
-
get
Returns the resource in a given resource at the specified index.- Parameters:
index
- an index to the wanted resource.- Returns:
- the sub resource UResourceBundle object
- Throws:
IndexOutOfBoundsException
- If the index value is out of bounds of accepted values.MissingResourceException
- If the resource bundle is missing.
-
findTopLevel
Deprecated.This API is ICU internal only.Returns a resource in a given resource that has a given index, or null if the resource is not found.- Parameters:
index
- the index of the resource- Returns:
- the resource, or null
- See Also:
-
getKeys
Returns the keys in this bundle as an enumeration- Specified by:
getKeys
in classResourceBundle
- Returns:
- an enumeration containing key strings, which is empty if this is not a bundle or a table resource
-
keySet
Deprecated.This API is ICU internal only.Returns a Set of all keys contained in this ResourceBundle and its parent bundles.- Overrides:
keySet
in classResourceBundle
- Returns:
- a Set of all keys contained in this ResourceBundle and its parent bundles, which is empty if this is not a bundle or a table resource
-
handleKeySet
Deprecated.This API is ICU internal only.Returns a Set of the keys contained only in this ResourceBundle. This does not include further keys from parent bundles.- Overrides:
handleKeySet
in classResourceBundle
- Returns:
- a Set of the keys contained only in this ResourceBundle, which is empty if this is not a bundle or a table resource
-
getSize
public int getSize()Returns the size of a resource. Size for scalar types is always 1, and for vector/table types is the number of child resources.
Note: Integer array is treated as a scalar type. There are no APIs to access individual members of an integer array. It is always returned as a whole.- Returns:
- number of resources in a given resource.
-
getType
public int getType()- Returns:
- type of the given resource.
-
getVersion
Return the version number associated with this UResourceBundle as an VersionInfo object.- Returns:
- VersionInfo object containing the version of the bundle
-
getIterator
Returns the iterator which iterates over this resource bundle- Returns:
- UResourceBundleIterator that iterates over the resources in the bundle
-
getKey
Returns the key associated with a given resource. Not all the resources have a key - only those that are members of a table.- Returns:
- a key associated to this resource, or null if it doesn't have a key
-
handleGet
protected UResourceBundle handleGet(String aKey, HashMap<String, String> aliasesVisited, UResourceBundle requested) Actual worker method for fetching a resource based on the given key. Sub classes must override this method if they support resources with keys.- Parameters:
aKey
- the key string of the resource to be fetchedaliasesVisited
- hashtable object to hold references of resources already seenrequested
- the original resource bundle object on which the get method was invoked. The requested bundle and the bundle on which this method is invoked are the same, except in the cases where aliases are involved.- Returns:
- UResourceBundle a resource associated with the key
-
handleGet
protected UResourceBundle handleGet(int index, HashMap<String, String> aliasesVisited, UResourceBundle requested) Actual worker method for fetching a resource based on the given index. Sub classes must override this method if they support arrays of resources.- Parameters:
index
- the index of the resource to be fetchedaliasesVisited
- hashtable object to hold references of resources already seenrequested
- the original resource bundle object on which the get method was invoked. The requested bundle and the bundle on which this method is invoked are the same, except in the cases where aliases are involved.- Returns:
- UResourceBundle a resource associated with the index
-
handleGetStringArray
Actual worker method for fetching the array of strings in a resource. Sub classes must override this method if they support arrays of strings.- Returns:
- String[] An array of strings containing strings
-
handleGetKeys
Actual worker method for fetching the keys of resources contained in the resource. Sub classes must override this method if they support keys and associated resources.- Returns:
- Enumeration An enumeration of all the keys in this resource.
-
handleGetObject
- Specified by:
handleGetObject
in classResourceBundle
-
isTopLevelResource
Deprecated.This API is ICU internal only.Is this a top-level resource, that is, a whole bundle?- Returns:
- true if this is a top-level resource
-