Skip to content

Most visited

Recently visited

navigation
Added in API level 1

PropertyResourceBundle

public class PropertyResourceBundle
extends ResourceBundle

java.lang.Object
   ↳ java.util.ResourceBundle
     ↳ java.util.PropertyResourceBundle


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
 

Note: PropertyResourceBundle can be constructed either from an InputStream or a Reader, which represents a property file. Constructing a PropertyResourceBundle instance from an InputStream requires that the input stream be encoded in ISO-8859-1. In that case, characters that cannot be represented in ISO-8859-1 encoding must be represented by Unicode Escapes as defined in section 3.3 of The Java™ Language Specification whereas the other constructor which takes a Reader does not have that limitation.

See also:

Summary

Inherited fields

From class java.util.ResourceBundle

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
From class java.lang.Object

Public constructors

PropertyResourceBundle

Added in API level 1
PropertyResourceBundle (InputStream stream)

Creates a property resource bundle from an InputStream. The property file read with this constructor must be encoded in ISO-8859-1.

Parameters
stream InputStream: an InputStream that represents a property file to read from.
Throws
IOException if an I/O error occurs
NullPointerException if stream is null

PropertyResourceBundle

Added in API level 9
PropertyResourceBundle (Reader reader)

Creates a property resource bundle from a Reader. Unlike the constructor PropertyResourceBundle(InputStream), there is no limitation as to the encoding of the input property file.

Parameters
reader Reader: a Reader that represents a property file to read from.
Throws
IOException if an I/O error occurs
NullPointerException if reader is null

Public methods

getKeys

Added in API level 1
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.

See also:

handleGetObject

Added in API level 1
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

Added in API level 9
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

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.