java.util

Class PropertyResourceBundle


public class PropertyResourceBundle
extends ResourceBundle

This class is a concrete ResourceBundle that gets it resources from a property file. This implies that the resources are strings. For more information about resource bundles see the class ResourceBundle. You should not use this class directly, or subclass it, but you get an object of this class automatically when you call ResourceBundle.getBundle() and there is a properties file. If there is also a class for this resource and the same locale, the class will be chosen. The properties file should have the name of the resource bundle, appended with the locale (e.g. _de and the extension .properties. The file should have the same format as for Properties.load() An example of a properties file for the german language is given here. This extends the example given in ListResourceBundle. Create a file MyResource_de.properties with the following contents and put it in the CLASSPATH. (The char \u00e4 is the german umlaut)
s1=3
s2=MeineDisk
s3=3. M\u00e4rz 96
s4=Die Diskette ''{1}'' enth\u00e4lt {0} in {2}.
s5=0
s6=keine Dateien
s7=1
s8=eine Datei
s9=2
s10={0,number} Dateien
s11=Die Formatierung warf eine Exception: {0}
s12=FEHLER
s13=Ergebnis
s14=Dialog
s15=Auswahlkriterium
s16=1,3
Since:
1.1
See Also:
ResourceBundle, ListResourceBundle, Properties.load(InputStream)

Field Summary

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

PropertyResourceBundle(InputStream stream)
Creates a new property resource bundle.
PropertyResourceBundle(Reader reader)
Creates a new property resource bundle.

Method Summary

Enumeration
getKeys()
This method should return all keys for which a resource exists.
Object
handleGetObject(String key)
Called by getObject when a resource is needed.

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, getBundle, getBundle, getBundle, getKeys, getLocale, getObject, getString, getStringArray, handleGetObject, setParent

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyResourceBundle

public PropertyResourceBundle(InputStream stream)
            throws IOException
Creates a new property resource bundle. The property file must be encoded using ISO-8859-1.
Parameters:
stream - an input stream, where the resources are read from
Throws:
NullPointerException - if stream is null
IOException - if reading the stream fails

PropertyResourceBundle

public PropertyResourceBundle(Reader reader)
            throws IOException
Creates a new property resource bundle. The encoding of the property file is determined by the supplied Reader object.
Parameters:
reader - an input stream, where the resources are read from
Throws:
NullPointerException - if stream is null
IOException - if reading the stream fails
Since:
1.6

Method Details

getKeys

public Enumeration getKeys()
This method should return all keys for which a resource exists.
Overrides:
getKeys in interface ResourceBundle
Returns:
an enumeration of the keys

handleGetObject

public Object handleGetObject(String key)
Called by getObject when a resource is needed. This returns the resource given by the key.
Overrides:
handleGetObject in interface ResourceBundle
Parameters:
key - the key of the resource
Returns:
the resource for the key, or null if it doesn't exist

PropertyResourceBundle -- a resource bundle built from a Property file Copyright (C) 1998, 1999, 2001, 2002 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.