java.util
Class PropertyResourceBundle

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle 
      extended by java.util.PropertyResourceBundle

public class PropertyResourceBundle
extends ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.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 sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle for more information about resource bundles. See Properties sample code for java.util.Properties definition code for java.util.Properties for more information about properties files, in particular the information on character encodings.

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 sample code for java.util.ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) definition code for java.util.ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) 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
See Also:
ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle , ListResourceBundle sample code for java.util.ListResourceBundle definition code for java.util.ListResourceBundle , Properties sample code for java.util.Properties definition code for java.util.Properties

Field Summary
 
Fields inherited from class java.util.ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle
parent sample code for java.util.ResourceBundle.parent definition code for java.util.ResourceBundle.parent
 
Constructor Summary
PropertyResourceBundle sample code for java.util.PropertyResourceBundle.PropertyResourceBundle(java.io.InputStream) definition code for java.util.PropertyResourceBundle.PropertyResourceBundle(java.io.InputStream) (InputStream sample code for java.io.InputStream definition code for java.io.InputStream  stream)
          Creates a property resource bundle.
 
Method Summary
 Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <String sample code for java.lang.String definition code for java.lang.String > getKeys sample code for java.util.PropertyResourceBundle.getKeys() definition code for java.util.PropertyResourceBundle.getKeys() ()
          Implementation of ResourceBundle.getKeys.
 Object sample code for java.lang.Object definition code for java.lang.Object handleGetObject sample code for java.util.PropertyResourceBundle.handleGetObject(java.lang.String) definition code for java.util.PropertyResourceBundle.handleGetObject(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  key)
          Gets an object for the given key from this resource bundle.
 
Methods inherited from class java.util.ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle
getBundle sample code for java.util.ResourceBundle.getBundle(java.lang.String) definition code for java.util.ResourceBundle.getBundle(java.lang.String) , getBundle sample code for java.util.ResourceBundle.getBundle(java.lang.String, java.util.Locale) definition code for java.util.ResourceBundle.getBundle(java.lang.String, java.util.Locale) , getBundle sample code for java.util.ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) definition code for java.util.ResourceBundle.getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) , getLocale sample code for java.util.ResourceBundle.getLocale() definition code for java.util.ResourceBundle.getLocale() , getObject sample code for java.util.ResourceBundle.getObject(java.lang.String) definition code for java.util.ResourceBundle.getObject(java.lang.String) , getString sample code for java.util.ResourceBundle.getString(java.lang.String) definition code for java.util.ResourceBundle.getString(java.lang.String) , getStringArray sample code for java.util.ResourceBundle.getStringArray(java.lang.String) definition code for java.util.ResourceBundle.getStringArray(java.lang.String) , setParent sample code for java.util.ResourceBundle.setParent(java.util.ResourceBundle) definition code for java.util.ResourceBundle.setParent(java.util.ResourceBundle)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

PropertyResourceBundle sample code for java.util.PropertyResourceBundle(java.io.InputStream) definition code for java.util.PropertyResourceBundle(java.io.InputStream)

public PropertyResourceBundle(InputStream sample code for java.io.InputStream definition code for java.io.InputStream  stream)
                       throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Creates a property resource bundle.

Parameters:
stream - property file to read from.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException
Method Detail

handleGetObject sample code for java.util.PropertyResourceBundle.handleGetObject(java.lang.String) definition code for java.util.PropertyResourceBundle.handleGetObject(java.lang.String)

public Object sample code for java.lang.Object definition code for java.lang.Object  handleGetObject(String sample code for java.lang.String definition code for java.lang.String  key)
Description copied from class: ResourceBundle sample code for java.util.ResourceBundle.handleGetObject(java.lang.String) definition code for java.util.ResourceBundle.handleGetObject(java.lang.String)
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 sample code for java.util.ResourceBundle.handleGetObject(java.lang.String) definition code for java.util.ResourceBundle.handleGetObject(java.lang.String) in class ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle
Parameters:
key - the key for the desired object
Returns:
the object for the given key, or null

getKeys sample code for java.util.PropertyResourceBundle.getKeys() definition code for java.util.PropertyResourceBundle.getKeys()

public Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <String sample code for java.lang.String definition code for java.lang.String > getKeys()
Implementation of ResourceBundle.getKeys.

Specified by:
getKeys sample code for java.util.ResourceBundle.getKeys() definition code for java.util.ResourceBundle.getKeys() in class ResourceBundle sample code for java.util.ResourceBundle definition code for java.util.ResourceBundle