Class ResourceManager


  • public class ResourceManager
    extends java.lang.Object
    Some helper functions for handling i18n issues. One instance of this class should be created for each resource.

    The ResourceManager is created by a call to getResourceManager(). The (optional) parameter is the name of the desired resource, not including the .properties suffix. For example,

    ResourceManager res = getResourceBundle();

    to get the default resources, or

    ResourceManager res = getResourceBundle("sql");

    to load the resources in sql.properties. To use the ResourceManager make a call to any of the format() methods. If a string is not found in the bundle the key is returned and a message is logged to the debug channel for this class.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String format​(java.lang.String key)
      Returns a string that has been obtained from the resource manager
      java.lang.String format​(java.lang.String pattern, java.lang.Object o0)
      Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
      java.lang.String format​(java.lang.String pattern, java.lang.Object o0, java.lang.Object o1)
      Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
      java.lang.String format​(java.lang.String pattern, java.lang.Object o0, java.lang.Object o1, java.lang.Object o2)
      Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
      java.lang.String format​(java.lang.String pattern, java.lang.Object o0, java.lang.Object o1, java.lang.Object o2, java.lang.Object o3)
      Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
      static ResourceManager getResourceManager()
      Returns the default resource manager.
      static ResourceManager getResourceManager​(java.lang.String resourceName)
      Returns the named resource manager.
      static void refresh()
      Clears the resource manager's cache of bundles (this should be called if the default locale for the application changes).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getResourceManager

        public static ResourceManager getResourceManager()
        Returns the default resource manager. An instance of the ResourceManager class is created the first time the method is called.
      • getResourceManager

        public static ResourceManager getResourceManager​(java.lang.String resourceName)
        Returns the named resource manager. An instance of the ResourceManager class is created the first time the method is called.
        Parameters:
        resourceName - The name of the desired resource
      • refresh

        public static void refresh()
        Clears the resource manager's cache of bundles (this should be called if the default locale for the application changes).
      • format

        public java.lang.String format​(java.lang.String key)
        Returns a string that has been obtained from the resource manager
        Parameters:
        key - The string that is the key to the translated message
      • format

        public java.lang.String format​(java.lang.String pattern,
                                       java.lang.Object o0)
        Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
        Parameters:
        pattern - The string that is the key to the translated message
        o0 - The param passed to format replaces {0}
      • format

        public java.lang.String format​(java.lang.String pattern,
                                       java.lang.Object o0,
                                       java.lang.Object o1)
        Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
        Parameters:
        pattern - The string that is the key to the translated message
        o0 - The param passed to format replaces {0}
        o1 - The param passed to format replaces {1}
      • format

        public java.lang.String format​(java.lang.String pattern,
                                       java.lang.Object o0,
                                       java.lang.Object o1,
                                       java.lang.Object o2)
        Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
        Parameters:
        pattern - The string that is the key to the translated message
        o0 - The param passed to format replaces {0}
        o1 - The param passed to format replaces {1}
        o2 - The param passed to format replaces {2}
      • format

        public java.lang.String format​(java.lang.String pattern,
                                       java.lang.Object o0,
                                       java.lang.Object o1,
                                       java.lang.Object o2,
                                       java.lang.Object o3)
        Returns a string that has been obtained from the resource manager then formatted using the passed parameters.
        Parameters:
        pattern - The string that is the key to the translated message
        o0 - The param passed to format replaces {0}
        o1 - The param passed to format replaces {1}
        o2 - The param passed to format replaces {2}
        o3 - The param passed to format replaces {3}