[portal-commits] JBoss Portal SVN: r6820 - trunk/common/src/main/org/jboss/portal/common/i18n.

Author: julien(a)jboss.com Date: 2007-03-25 08:48:44 -0400 (Sun, 25 Mar 2007) New Revision: 6820 Modified: trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleFactory.java trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleManager.java Log: resource bundle manager and factory basic javadoc Modified: trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleFactory.java =================================================================== --- trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleFactory.java 2007-03-25 02:23:56 UTC (rev 6819) +++ trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleFactory.java 2007-03-25 12:48:44 UTC (rev 6820) @@ -26,6 +26,8 @@ import java.util.Locale; /** + * Definition of a factory for resource bundles. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ */ Modified: trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleManager.java =================================================================== --- trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleManager.java 2007-03-25 02:23:56 UTC (rev 6819) +++ trunk/common/src/main/org/jboss/portal/common/i18n/ResourceBundleManager.java 2007-03-25 12:48:44 UTC (rev 6820) @@ -33,8 +33,12 @@ import java.util.MissingResourceException; /** - * Manage a set of resource bundles. + * <p>Manage a set of resource bundles. Obtention of bundles is done using a ResourceBundleFactory object. + * A bundle obtained succesfully is cached in order to avoid the potential expensive cost of bundle obtention.</p> * + * <p>The manager can also be used to build LocalizedString object from the loaded bundles.</p> + * + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @author <a href="mailto:theute@jboss.org">Thomas Heute</a> * @version $Revision: 6697 $ @@ -42,20 +46,29 @@ public class ResourceBundleManager { - /** */ + /** . */ private Logger log = Logger.getLogger(getClass()); - /** */ + /** . */ private volatile Map localeBundles; - /** */ + /** . */ private ResourceBundle defaultBundle; - /** */ + /** . */ private ResourceBundleFactory resourceBundleFactory; - public ResourceBundleManager(ResourceBundle defaultBundle, ResourceBundleFactory resourceBundleFactory) + /** + * @param defaultBundle the default bundle returned when no bundle has been obtained for the locale + * @param resourceBundleFactory the resource bundle factory + * @throws IllegalArgumentException IllegalArgumentException if the resource bundle factory is null + */ + public ResourceBundleManager(ResourceBundle defaultBundle, ResourceBundleFactory resourceBundleFactory) throws IllegalArgumentException { + if (resourceBundleFactory == null) + { + throw new IllegalArgumentException("Need a resource bundle factory"); + } this.localeBundles = new HashMap(); this.defaultBundle = defaultBundle; this.resourceBundleFactory = resourceBundleFactory;