Added in API level 1

Summary: Inherited Fields | Ctors | Methods | Protected Methods | Inherited Methods

ListResourceBundle

public abstract class ListResourceBundle
extends ResourceBundle

java.lang.Object
↳	java.util.ResourceBundle
	↳	java.util.ListResourceBundle

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
         };
     }
 }

The implementation of a ListResourceBundle 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.

See also:

Summary

Inherited fields

From class java.util.ResourceBundle


    protected
    
    
    ResourceBundle

parent

The parent bundle of this bundle.

Public constructors
`ListResourceBundle()` Sole constructor.

Public methods
`Enumeration<String>`	`getKeys()` Returns an `Enumeration` of the keys contained in this `ResourceBundle` and its parent bundles.
`final Object`	`handleGetObject(String key)` Gets an object for the given key from this resource bundle.

Protected methods
`abstract Object[][]`	`getContents()` Returns an array in which each item is a pair of objects in an `Object` array.
`Set<String>`	`handleKeySet()` Returns a `Set` of the keys contained only in this `ResourceBundle`.

Inherited methods

From class


        
          java.util.ResourceBundle

`static final void`	`clearCache(ClassLoader loader)` Removes all resource bundles from the cache that have been loaded by the given class loader.
`static final void`	`clearCache()` Removes all resource bundles from the cache that have been loaded using the caller's class loader.
`boolean`	`containsKey(String key)` Determines whether the given `key` is contained in this `ResourceBundle` or its parent bundles.
`String`	`getBaseBundleName()` Returns the base name of this bundle, if known, or `null` if unknown.
`static final ResourceBundle`	`getBundle(String baseName, Locale targetLocale, ResourceBundle.Control control)` Returns a resource bundle using the specified base name, target locale and control, and the caller's class loader.
`static final ResourceBundle`	`getBundle(String baseName, Locale locale)` Gets a resource bundle using the specified base name and locale, and the caller's class loader.
`static final ResourceBundle`	`getBundle(String baseName)` Gets a resource bundle using the specified base name, the default locale, and the caller's class loader.
`static ResourceBundle`	`getBundle(String baseName, Locale targetLocale, ClassLoader loader, ResourceBundle.Control control)` Returns a resource bundle using the specified base name, target locale, class loader and control.
`static ResourceBundle`	`getBundle(String baseName, Locale locale, ClassLoader loader)` Gets a resource bundle using the specified base name, locale, and class loader.
`static final ResourceBundle`	`getBundle(String baseName, ResourceBundle.Control control)` Returns a resource bundle using the specified base name, the default locale and the specified control.
`abstract Enumeration<String>`	`getKeys()` Returns an enumeration of the keys.
`Locale`	`getLocale()` Returns the locale of this resource bundle.
`final Object`	`getObject(String key)` Gets an object for the given key from this resource bundle or one of its parents.
`final String`	`getString(String key)` Gets a string for the given key from this resource bundle or one of its parents.
`final String[]`	`getStringArray(String key)` Gets a string array for the given key from this resource bundle or one of its parents.
`abstract Object`	`handleGetObject(String key)` Gets an object for the given key from this resource bundle.
`Set<String>`	`handleKeySet()` Returns a `Set` of the keys contained only in this `ResourceBundle`.
`Set<String>`	`keySet()` Returns a `Set` of all keys contained in this `ResourceBundle` and its parent bundles.
`void`	`setParent(ResourceBundle parent)` Sets the parent bundle of this bundle.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors