org.graalvm.shadowed.com.ibm.icu.util

Class UResourceBundle

java.lang.Object

java.util.ResourceBundle

org.graalvm.shadowed.com.ibm.icu.util.UResourceBundle

Direct Known Subclasses:

ICUResourceBundle, ResourceBundleWrapper

public abstract class UResourceBundle
extends ResourceBundle

.

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.res
 

JAVA/JDK:

    LocaleElements.res
         |
      -------------------
     |                   |
 LocaleElements_fr.res  LocaleElements_en.res
     |
   ---------------------------
  |                            |
 LocaleElements_fr_CA.res   LocaleElements_fr_FR.res
 

Depending 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

Nested Class Summary

Nested classes/interfaces inherited from class java.util.ResourceBundle

ResourceBundle.Control

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRAY Resource type constant for arrays of resources.
static int	BINARY Resource type constant for binary data.
static int	INT Resource type constant for a single 28-bit integer, interpreted as signed or unsigned by the getInt() function.
static int	INT_VECTOR Resource type constant for vectors of 32-bit integers.
static int	NONE Resource type constant for "no resource".
static int	STRING Resource type constant for strings.
static int	TABLE Resource type constant for tables of key-value pairs.

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

Constructors

Constructor and Description
UResourceBundle() Sole constructor.

Method Summary

Modifier and Type	Method and Description
UResourceBundle	get(int index) Returns the resource in a given resource at the specified index.
UResourceBundle	get(String aKey) Returns a resource in a given resource that has a given key.
protected abstract String	getBaseName() Returns the base name of the resource bundle
ByteBuffer	getBinary() Returns 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(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, 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.
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, 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(ULocale locale) Creates a UResourceBundle for the locale specified, from which users can extract resources by using their corresponding keys.
int	getInt() Returns a signed integer from a resource.
int[]	getIntVector() Returns a 32 bit integer array from a resource.
UResourceBundleIterator	getIterator() Returns the iterator which iterates over this resource bundle
String	getKey() Returns the key associated with a given resource.
Enumeration<String>	getKeys() Returns the keys in this bundle as an enumeration
Locale	getLocale() Returns the locale of this bundle
protected abstract String	getLocaleID() Returns the localeID
protected abstract UResourceBundle	getParent() Returns the parent bundle
int	getSize() Returns the size of a resource.
String	getString() Returns a string from a string resource type
String	getString(int index) Returns the string in a given resource at the specified index.
String[]	getStringArray() Returns a string array from a array resource type
int	getType() Returns the type of a resource.
int	getUInt() Returns a unsigned integer from a resource.
abstract ULocale	getULocale() Returns the RFC 3066 conformant locale id of this resource bundle.
VersionInfo	getVersion() 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	handleGet(String aKey, HashMap<String,String> aliasesVisited, UResourceBundle requested) Actual worker method for fetching a resource based on the given key.
protected Enumeration<String>	handleGetKeys() Actual worker method for fetching the keys of resources contained in the resource.
protected Object	handleGetObject(String aKey)
protected String[]	handleGetStringArray() Actual worker method for fetching the array of strings in a resource.
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.

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getObject, getString, getStringArray, handleKeySet, keySet, setParent

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

Resource type constant for "no resource".

See Also:

Constant Field Values

STRING

public static final int STRING

Resource type constant for strings.

See Also:

Constant Field Values

BINARY

public static final int BINARY

Resource type constant for binary data.

See Also:

Constant Field Values

TABLE

public static final int TABLE

Resource type constant for tables of key-value pairs.

See Also:

Constant Field Values

INT

public static final int INT

Resource type constant for a single 28-bit integer, interpreted as signed or unsigned by the getInt() function.

See Also:

UResourceBundle.getInt(), Constant Field Values

ARRAY

public static final int ARRAY

Resource type constant for arrays of resources.

See Also:

Constant Field Values

INT_VECTOR

public static final int INT_VECTOR

Resource type constant for vectors of 32-bit integers.

See Also:

UResourceBundle.getIntVector(), Constant Field Values

Constructor Detail

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 Detail

getBundleInstance

public static UResourceBundle getBundleInstance(String baseName,
                                                String localeName)

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 desired

root - 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 desired

root - the class object from which to load the resource bundle

disableFallback - 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

public static UResourceBundle getBundleInstance(ULocale locale)

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

public 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.

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

public 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.

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

public static UResourceBundle getBundleInstance(String baseName,
                                                ULocale locale)

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

public 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.

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

public abstract ULocale 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

protected abstract String getLocaleID()

Returns the localeID

Returns:

The string representation of the localeID

getBaseName

protected abstract String getBaseName()

Returns the base name of the resource bundle

Returns:

The string representation of the base name

getParent

protected abstract UResourceBundle getParent()

Returns the parent bundle

Returns:

The parent bundle

getLocale

public Locale getLocale()

Returns the locale of this bundle

Overrides:

getLocale in class ResourceBundle

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 desired

root - the class object from which to load the resource bundle

disableFallback - 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

public ByteBuffer 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:

UResourceBundle.getIntVector(), UResourceBundle.getInt()

getString

public String 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:

UResourceBundle.getBinary(), UResourceBundle.getIntVector(), UResourceBundle.getInt()

getStringArray

public String[] 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:

UResourceBundle.getString(), UResourceBundle.getIntVector()

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:

UResourceBundle.getIntVector(), UResourceBundle.getInt()

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:

UResourceBundle.getBinary(), UResourceBundle.getInt()

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:

UResourceBundle.getIntVector(), UResourceBundle.getBinary()

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:

UResourceBundle.getIntVector(), UResourceBundle.getBinary()

get

public UResourceBundle get(String aKey)

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.

getString

public String getString(int index)

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

public UResourceBundle get(int index)

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.

getKeys

public Enumeration<String> getKeys()

Returns the keys in this bundle as an enumeration

Specified by:

getKeys in class ResourceBundle

Returns:

an enumeration containing key strings, 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 the type of a resource. Available types are INT, ARRAY, BINARY, INT_VECTOR, STRING, TABLE.

Returns:

type of the given resource.

getVersion

public VersionInfo getVersion()

Return the version number associated with this UResourceBundle as an VersionInfo object.

Returns:

VersionInfo object containing the version of the bundle

getIterator

public UResourceBundleIterator getIterator()

Returns the iterator which iterates over this resource bundle

Returns:

UResourceBundleIterator that iterates over the resources in the bundle

getKey

public String 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 fetched

aliasesVisited - hashtable object to hold references of resources already seen

requested - 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 fetched

aliasesVisited - hashtable object to hold references of resources already seen

requested - 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

protected String[] 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

protected Enumeration<String> 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

protected Object handleGetObject(String aKey)

Specified by:

handleGetObject in class ResourceBundle