PropertyResourceBundle

PropertyResourceBundle | API reference | Android Developers

public class PropertyResourceBundle
extends ResourceBundle

PropertyResourceBundle is a concrete subclass of ResourceBundle that manages resources for a locale using a set of static strings from a property file. See ResourceBundle for more information about resource bundles.

Unlike other types of resource bundle, you don't subclass PropertyResourceBundle. Instead, you supply properties files containing the resource data. ResourceBundle.getBundle will automatically look for the appropriate properties file and create a PropertyResourceBundle that refers to it. See ResourceBundle.getBundle for a complete description of the search and instantiation strategy.

The following example shows a member of a resource bundle family with the base name "MyResources". The text defines the bundle "MyResources_de", the German member of the bundle family. This member is based on PropertyResourceBundle, and the text therefore is the content of the file "MyResources_de.properties" (a related example shows how you can add bundles to this family that are implemented as subclasses of ListResourceBundle). 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.

 # MessageFormat pattern
 s1=Die Platte \"{1}\" enthält {0}.

 # location of {0} in pattern
 s2=1

 # sample disk name
 s3=Meine Platte

 # first ChoiceFormat choice
 s4=keine Dateien

 # second ChoiceFormat choice
 s5=eine Datei

 # third ChoiceFormat choice
 s6={0,number} Dateien

 # sample date
 s7=3. März 1996

Inherited fields

From class java.util.ResourceBundle


    protected
    
    
    ResourceBundle

parent

The parent bundle of this bundle.

Public constructors
`PropertyResourceBundle(InputStream stream)` Creates a property resource bundle from an `InputStream`.
`PropertyResourceBundle(Reader reader)` Creates a property resource bundle from a `Reader`.

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

Protected methods
`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

public PropertyResourceBundle (InputStream stream)

Creates a property resource bundle from an InputStream. This constructor reads the property file in UTF-8 by default. If a MalformedInputException or an UnmappableCharacterException occurs on reading the input stream, then the PropertyResourceBundle instance resets to the state before the exception, re-reads the input stream in ISO-8859-1 and continues reading. If the system property java.util.PropertyResourceBundle.encoding is set to either "ISO-8859-1" or "UTF-8", the input stream is solely read in that encoding, and throws the exception if it encounters an invalid sequence. Other encoding values are ignored for this system property. The system property is read and evaluated when initializing this class. Changing or removing the property has no effect after the initialization.

Parameters
`stream`	`InputStream`: an InputStream that represents a property file to read from.

Throws
`IOException`	if an I/O error occurs
`IllegalArgumentException`	if `stream` contains a malformed Unicode escape sequence.
`NullPointerException`	if `stream` is null
`MalformedInputException`	if the system property `java.util.PropertyResourceBundle.encoding` is set to "UTF-8" and `stream` contains an invalid UTF-8 byte sequence.
`UnmappableCharacterException`	if the system property `java.util.PropertyResourceBundle.encoding` is set to "UTF-8" and `stream` contains an unmappable UTF-8 byte sequence.

Public methods

getKeys

public Enumeration<String> getKeys ()

Returns an Enumeration of the keys contained in this ResourceBundle and its parent bundles.

Returns
`Enumeration<String>`	an `Enumeration` of the keys contained in this `ResourceBundle` and its parent bundles.

handleGetObject

public 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.

Parameters
`key`	`String`: the key for the desired object

Returns
`Object`	the object for the given key, or null

Protected methods

handleKeySet

protected Set<String> handleKeySet ()

Returns a Set of the keys contained only in this ResourceBundle.

Returns
`Set<String>`	a `Set` of the keys contained only in this `ResourceBundle`