- Direct Known Subclasses:
AccessibleResourceBundle
ListResourceBundle is an abstract subclass ofResourceBundle that manages resources for a locale in a convenient and easy to use list. SeeResourceBundle for more information about resource bundles in general. Subclasses must overridegetContents and provide an array, where each item in the array is a pair of objects. The first element of each pair is the key, which must be aString, and the second element is the value associated with that key.
The followingexample shows two members of a resource bundle family with the base name "MyResources". "MyResources" is the default member of the bundle family, and "MyResources_fr" is the French member. These members are based onListResourceBundle (a relatedexample shows how you can add a bundle to this family that's based on a properties file). The keys in this example are of the form "s1" etc. The actual keys are entirely up to your choice, so long as they are the same as the keys you use in your program to retrieve the objects from the bundle. Keys are case-sensitive.
public class MyResources extends ListResourceBundle { protected Object[][] getContents() { return new Object[][] { // LOCALIZE THIS {"s1", "The disk \"{1}\" contains {0}."}, // MessageFormat pattern {"s2", "1"}, // location of {0} in pattern {"s3", "My Disk"}, // sample disk name {"s4", "no files"}, // first ChoiceFormat choice {"s5", "one file"}, // second ChoiceFormat choice {"s6", "{0,number} files"}, // third ChoiceFormat choice {"s7", "3 Mar 96"}, // sample date {"s8", new Dimension(1,5)} // real object, not just string // END OF MATERIAL TO LOCALIZE }; } } public class MyResources_fr extends ListResourceBundle { protected Object[][] getContents() { return new Object[][] { // LOCALIZE THIS {"s1", "Le disque \"{1}\" {0}."}, // MessageFormat pattern {"s2", "1"}, // location of {0} in pattern {"s3", "Mon disque"}, // sample disk name {"s4", "ne contient pas de fichiers"}, // first ChoiceFormat choice {"s5", "contient un fichier"}, // second ChoiceFormat choice {"s6", "contient {0,number} fichiers"}, // third ChoiceFormat choice {"s7", "3 mars 1996"}, // sample date {"s8", new Dimension(1,3)} // real object, not just string // END OF MATERIAL TO LOCALIZE }; } } The implementation of aListResourceBundle subclass must be thread-safe if it's simultaneously used by multiple threads. The default implementations of the methods in this class are thread-safe.
- Since:
- 1.1
- See Also:
Nested Class Summary
Nested classes/interfaces declared in class java.util.ResourceBundle
ResourceBundle.ControlField Summary
Fields declared in class java.util.ResourceBundle
parentConstructor Summary
ConstructorsMethod Summary
Modifier and TypeMethodDescriptionprotected abstractObject[][]Returns an array in which each item is a pair of objects in anObjectarray.getKeys()Returns anEnumerationof the keys contained in thisResourceBundleand its parent bundles.finalObjecthandleGetObject(String key) Gets an object for the given key from this resource bundle.Returns aSetof the keys containedonly in thisResourceBundle.Methods declared in class java.util.ResourceBundle
clearCache,clearCache,containsKey,getBaseBundleName,getBundle,getBundle,getBundle,getBundle,getBundle,getBundle,getBundle,getBundle,getLocale,getObject,getString,getStringArray,keySet,setParent
Constructor Details
ListResourceBundle
public ListResourceBundle()Sole constructor. (For invocation by subclass constructors, typically implicit.)
Method Details
handleGetObject
Description copied from class:ResourceBundleGets an object for the given key from this resource bundle. Returns null if this resource bundle does not contain an object for the given key.- Specified by:
handleGetObjectin classResourceBundle- Parameters:
key- the key for the desired object- Returns:
- the object for the given key, or null
getKeys
Returns anEnumerationof the keys contained in thisResourceBundleand its parent bundles.- Specified by:
getKeysin classResourceBundle- Returns:
- an
Enumerationof the keys contained in thisResourceBundleand its parent bundles. - See Also:
handleKeySet
Returns aSetof the keys containedonly in thisResourceBundle.- Overrides:
handleKeySetin classResourceBundle- Returns:
- a
Setof the keys contained only in thisResourceBundle - Since:
- 1.6
- See Also:
getContents
Returns an array in which each item is a pair of objects in anObjectarray. The first element of each pair is the key, which must be aString, and the second element is the value associated with that key. See the class description for details.- Returns:
- an array of an
Objectarray representing a key-value pair.