PropertyResourceBundle (Java 2 Platform SE 5.0) (original) (raw)

java.util

Class PropertyResourceBundle

java.lang.Object extended by java.util.ResourceBundle java.util.PropertyResourceBundle

public class PropertyResourceBundle

PropertyResourceBundle is a concrete subclass ofResourceBundle that manages resources for a locale using a set of static strings from a property file. SeeResourceBundle for more information about resource bundles. See Properties for more information about properties files, in particular theinformation on character encodings.

Unlike other types of resource bundle, you don't subclassPropertyResourceBundle. Instead, you supply properties files containing the resource data. ResourceBundle.getBundle will automatically look for the appropriate properties file and create aPropertyResourceBundle that refers to it. See[ResourceBundle.getBundle](../../java/util/ResourceBundle.html#getBundle%28java.lang.String, java.util.Locale, java.lang.ClassLoader%29) 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

Since:

JDK1.1

Field Summary

Fields inherited from class java.util.ResourceBundle
parent

Constructor Summary
PropertyResourceBundle(InputStream stream) Creates a property resource bundle.

Method Summary
Enumeration<String>	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](../../java/util/ResourceBundle.html#getBundle%28java.lang.String, java.util.Locale%29), [getBundle](../../java/util/ResourceBundle.html#getBundle%28java.lang.String, java.util.Locale, java.lang.ClassLoader%29), getLocale, getObject, getString, getStringArray, setParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

PropertyResourceBundle

public PropertyResourceBundle(InputStream stream) throws IOException

Creates a property resource bundle.

Parameters:

stream - property file to read from.

Throws:

[IOException](../../java/io/IOException.html "class in java.io")

Method Detail

handleGetObject

public Object handleGetObject(String key)

Description copied from class: [ResourceBundle](../../java/util/ResourceBundle.html#handleGetObject%28java.lang.String%29)

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.

Specified by:

[handleGetObject](../../java/util/ResourceBundle.html#handleGetObject%28java.lang.String%29) in class [ResourceBundle](../../java/util/ResourceBundle.html "class in java.util")

Parameters:

key - the key for the desired object

Returns:

the object for the given key, or null

getKeys

public Enumeration<String> getKeys()

Implementation of ResourceBundle.getKeys.

Specified by:

[getKeys](../../java/util/ResourceBundle.html#getKeys%28%29) in class [ResourceBundle](../../java/util/ResourceBundle.html "class in java.util")

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.