java.util

Class ListResourceBundle

Known Direct Subclasses:
AccessibleResourceBundle, BMPMetadataFormatResources, DataPackageResources, DataPackageResources_de, DataPackageResources_es, DataPackageResources_fr, DataPackageResources_pl, DataPackageResources_ru, GIFImageMetadataFormatResources, GIFStreamMetadataFormatResources, gtk, gtk_de, gtk_es, gtk_fr, gtk_it, gtk_ja, gtk_ko, gtk_sv, gtk_zh_CN, gtk_zh_HK, gtk_zh_TW, JFreeChartResources, JPEGImageReaderResources, JPEGImageWriterResources, MessagesResources_fr, motif, motif_de, motif_es, motif_fr, motif_it, motif_ja, motif_ko, motif_sv, motif_zh_CN, motif_zh_HK, motif_zh_TW, PNGMetadataFormatResources, StandardMetadataFormatResources, windows, windows_de, windows_es, windows_fr, windows_it, windows_ja, windows_ko, windows_sv, windows_zh_CN, windows_zh_HK, windows_zh_TW

public abstract class ListResourceBundle
extends ResourceBundle

ListResourceBundle is an abstract subclass of ResourceBundle that manages resources for a locale in a convenient and easy to use list. See ResourceBundle for more information about resource bundles in general.

Subclasses must override getContents 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 a String, and the second element is the value associated with that key.

The following example 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 on ListResourceBundle (a related example 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
         };
     }
 }
 
Since:
JDK1.1
See Also:
ResourceBundle, PropertyResourceBundle

Field Summary

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

ListResourceBundle()
Sole constructor.

Method Summary

protected abstract Object[][]
getContents()
See class description.
Enumeration
getKeys()
Implementation of ResourceBundle.getKeys.
Object
handleGetObject(String key)
Gets an object for the given key from this resource bundle.

Methods inherited from class java.util.ResourceBundle

getBundle, getBundle, getBundle, getKeys, getLocale, getObject, getString, getStringArray, handleGetObject, setParent

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListResourceBundle

public ListResourceBundle()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Usages and Demos :

View More Examples of ListResourceBundle()
   1:     }
   2:     private final static ResourceBundle EMPTY_BUNDLE = new ListResourceBundle() {
   3:         @Override
   4:         protected Object[][] getContents() {
   5:             return new Object[0][];

View Full Code Here
   1: public class AbstraktCacheServiceConfigurationTest {
   2:     private static ResourceBundle rb = new ListResourceBundle() {
   3:         @Override
   4:         protected Object[][] getContents() {
   5:             return new Object[][] { { "a", "b" }, { "c", "d" } };

View Full Code Here
   1:         setupStub(initParams, mockConfig, "getInitParameter");
   2:         mockConfig.stubs().method("getResourceBundle").will(returnValue(new ListResourceBundle() {
   3:             protected Object[][] getContents() {
   4:                 return new String[][]{{"javax.portlet.title", "MyTitle"}};
   5:             }

View Full Code Here
   1:         if (bundle == null) {
   2:             bundle = new ListResourceBundle() {
   3: 
   4:                 protected Object[][] getContents() {
   5:                     return new String[][]{};

View Full Code Here
   1: 
   2:         ResourceBundle b = new ListResourceBundle() {
   3:             public Object[][] getContents() {
   4:                 final Object[][] contents = new Object[in.size()][2];
   5:                 final Iterator i = in.keySet().iterator();

View Full Code Here

Method Details

getContents

protected abstract Object[][] getContents()
See class description.

getKeys

public Enumeration getKeys()
Implementation of ResourceBundle.getKeys.
Overrides:
getKeys in interface ResourceBundle

handleGetObject

public final Object handleGetObject(String key)
Gets 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.
Overrides:
handleGetObject in interface ResourceBundle
Parameters:
key - the key for the desired object
Returns:
the object for the given key, or null
Throws:
NullPointerException - if key is null