Package com.adobe.agl.util

Class UResourceBundle

  • Direct Known Subclasses:
    ICUResourceBundle, ResourceBundleWrapper
    public abstract class UResourceBundle
extends java.util.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 class, an object is created and the sub items are fetched using getString, 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 which 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);
    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

        java.util.ResourceBundle.Control

    • Field Summary

      Fields 
      Modifier and Type Field 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.

    • Constructor Summary

      Constructors 
      Constructor Description
      UResourceBundle()
      Sole constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      UResourceBundle get​(java.lang.String aKey)
      Returns a resource in a given resource that has a given key.
      java.nio.ByteBuffer getBinary()
      Returns a binary data from a binary resource.
      byte[] getBinary​(byte[] ba)
      Returns a binary data from a binary resource.
      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​(java.lang.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​(java.lang.String baseName, ULocale locale)
      Creates a UResourceBundle, from which users can extract resources by using their corresponding keys.
      static UResourceBundle getBundleInstance​(java.lang.String baseName, ULocale locale, java.lang.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​(java.lang.String baseName, java.lang.String localeName)
      Creates a resource bundle using the specified base name and locale.
      static UResourceBundle getBundleInstance​(java.lang.String baseName, java.lang.String localeName, java.lang.ClassLoader root)
      Creates a resource bundle using the specified base name, locale, and class root.
      static UResourceBundle getBundleInstance​(java.lang.String baseName, java.util.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​(java.lang.String baseName, java.util.Locale locale, java.lang.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[] getIntVector()
      Returns a 32 bit integer array from a resource.
      java.lang.String getKey()
      Returns the key associated with a given resource.
      java.util.Locale getLocale()
      Get the locale of this bundle
      int getSize()
      Returns the size of a resource.
      java.lang.String getString()
      Returns a string from a string resource type
      java.lang.String[] getStringArray()
      Returns a string array from a array resource type
      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.

      • Methods inherited from class java.util.ResourceBundle

        clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getKeys, getObject, getString, getStringArray, keySet

      • Methods inherited from class java.lang.Object

        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:
        getInt(), Constant Field Values

      • ARRAY

        public static final int ARRAY
        Resource type constant for arrays of resources.
        See Also:
        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​(java.lang.String baseName,
                                                java.lang.String localeName)
        Creates a resource bundle using the specified base name and locale. ICU_DATA_CLASS is used as the default root.
        Parameters:
        baseName - the base name of the resource bundle, a fully qualified class name
        localeName - the locale for which a resource bundle is desired
        Returns:
        a resource bundle for the given base name and locale
        Throws:
        java.util.MissingResourceException - if no resource bundle for the specified base name can be found

      • getBundleInstance

        public static UResourceBundle getBundleInstance​(java.lang.String baseName,
                                                java.lang.String localeName,
                                                java.lang.ClassLoader root)
        Creates a resource bundle using the specified base name, locale, and class root.
        Parameters:
        baseName - the base name of the resource bundle, a fully qualified class name
        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:
        java.util.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​(java.lang.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 - 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 default locale

      • getBundleInstance

        public static UResourceBundle getBundleInstance​(java.lang.String baseName,
                                                java.util.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 - specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.
        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​(java.lang.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​(java.lang.String baseName,
                                                java.util.Locale locale,
                                                java.lang.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 - specifies the locale for which we want to open the resource. If null the bundle for default locale is opened.
        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​(java.lang.String baseName,
                                                ULocale locale,
                                                java.lang.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

      • getLocale

        public java.util.Locale getLocale()
        Get the locale of this bundle
        Overrides:
        getLocale in class java.util.ResourceBundle
        Returns:
        the locale of this resource bundle

      • getBinary

        public java.nio.ByteBuffer getBinary()
        Returns a binary data from a binary resource.
        Returns:
        a pointer to a chuck of unsigned bytes which live in a memory mapped/DLL file.
        Throws:
        java.util.MissingResourceException
        UResourceTypeMismatchException
        See Also:
        getIntVector(), getInt()

      • getBinary

        public byte[] getBinary​(byte[] ba)
        Returns a binary data from a binary resource.
        Parameters:
        ba - The byte array to write the bytes to. A null variable is OK.
        Returns:
        an array bytes containing the binary data from the resource.
        Throws:
        java.util.MissingResourceException
        UResourceTypeMismatchException
        See Also:
        getIntVector(), 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:
        java.util.MissingResourceException
        UResourceTypeMismatchException
        See Also:
        getBinary(), getInt()

      • 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:
        java.util.MissingResourceException
        UResourceTypeMismatchException
        See Also:
        getIntVector(), getBinary()

      • get

        public UResourceBundle get​(java.lang.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:
        java.util.MissingResourceException

      • 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.
        Warning: 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.

      • 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

      • getKey

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