MultiplePropertiesResourceBundle is an abstract base implementation to allow to
* combine a ResourceBundle from multiple properties files whereas these properties files must end
* with the same name - the base-name for these combined ResourceBundle.
*
* A concrete implementation must subclass this class and provide a default constructor in which
* super("base-name"); or super("package.name","base-name"); must be
* called depending on if your properties files are located in default or a specific package.
*
* public class ExampleResourceBundle extends MultiplePropertiesResourceBundle {
* public ExampleResourceBundle() {
* super("example");
* }
* }
*
* or
*
* public class ExampleResourceBundle extends MultiplePropertiesResourceBundle {
* public ExampleResourceBundle() {
* super("my.package", "example");
* }
* }
*
*
* * For each Locale that you need to support you also must provide Locale variants of your java * ResourceBindle class as shown below. Creating an empty subclass of the above class does the job - * the separate class is needed to let {@link java.util.ResourceBundle#getBundle(String, java.util.Locale)} find and * cache your bundle with the right Locale. *
* *
* public class ExampleResourceBundle_de extends ExampleResourceBundle {
* }
*
*
* * To allow automatic detection of the multiple properties files, for each filename you must provide * a general properties file without any Locale extension in the name (e.g. * additional-example.properties as a variant to examples.properties) - otherwise that properties * file name will not be used to load as PropertyResourceBundle. Let's assume we used the base-name * "example" and the following list of properties files are reachable: *
*
* Only example and additional-example will be used as base-names to load this
* MultiplePropertiesResourceBundle - another-example.properties is missing
* and therefore another-example is not detected as a valid base-name.
*
* It is also supported to provide additional properties files with a jar file. To make sure that * jar file is recognized as properties file provider it must contain a file "base-name".properties * (e.g. example.properties). This marker file may be empty and is only used to find all resource * paths containing properties files of interest (with matching base-name). In fact, every path * location containing properties files to be combined into one MultiplePropertiesResourceBundle * must contain that "base-name".properties file. *
** The load order of the properties files is base-named file first and then the additional * properties files in natural sort order of the file name. Properties files loaded later may * override previously loaded properties. *
* * @author Hanspeter Dünnenberger * ** Here was appended additional constructor which don't receive parameters if you would like to load * ANY *.properties file which you define in resources folder you should extend this class with * constructor without arguments. Then this class expects that it find one main (default) property * file with name resources.properties but it load also any other .properties file from this * folder without constraints of its name. Other features from this library will be still working. * You can not use '.' and '_' in property file name because then filenames wrongly will parse * and you'll receive NullPointerException while creating ResourceBandle. *
* @author Michał Rowicki */ public abstract class MultiplePropertiesResourceBundle extends ResourceBundle { private static final String CLASS = MultiplePropertiesResourceBundle.class.getName(); /** private Logger instance */ private static final Logger LOG = Logger.getLogger(CLASS); /** * The base name for the ResourceBundles to load in. */ private String baseName; /** * The package name where the properties files should be. */ private String packageName; /** * A Map containing the combined resources of all parts building this * MultiplePropertiesResourceBundle. */ private MapMultiplePropertiesResourceBundle for the all properties.
*/
protected MultiplePropertiesResourceBundle() {
this(null, "");
}
/**
* Construct a MultiplePropertiesResourceBundle for the passed in base-name.
*
* @param baseName
* the base-name that must be part of the properties file names.
*/
protected MultiplePropertiesResourceBundle(String baseName) {
this(null, baseName);
}
/**
* Construct a MultiplePropertiesResourceBundle for the passed in base-name.
*
* @param packageName
* the package name where the properties files should be.
* @param baseName
* the base-name that must be part of the properties file names.
*/
protected MultiplePropertiesResourceBundle(String packageName, String baseName) {
this.packageName = packageName;
this.baseName = baseName;
}
@Override
public Object handleGetObject(String key) {
if (key == null) {
throw new NullPointerException();
}
loadBundlesOnce();
return combined.get(key);
}
@Override
public Enumeration