Home » openjdk-7 » java » util » [javadoc | source]
public class: PropertyResourceBundle [javadoc | source]
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

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

Fields inherited from java.util.ResourceBundle:
 public PropertyResourceBundle(InputStream stream) throws IOException 
    Creates a property resource bundle from an InputStream . The property file read with this constructor must be encoded in ISO-8859-1.
    stream - an InputStream that represents a property file to read from.
    IOException - if an I/O error occurs
    NullPointerException - if stream is null
 public PropertyResourceBundle(Reader reader) throws IOException 
    reader - a Reader that represents a property file to read from.
    IOException - if an I/O error occurs
    NullPointerException - if reader is null
    since: 1.6 -
Method from java.util.PropertyResourceBundle Summary:
getKeys,   handleGetObject,   handleKeySet
Methods from java.util.ResourceBundle:
clearCache,   clearCache,   containsKey,   getBundle,   getBundle,   getBundle,   getBundle,   getBundle,   getBundle,   getKeys,   getLocale,   getObject,   getString,   getStringArray,   handleGetObject,   handleKeySet,   keySet,   setParent
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.PropertyResourceBundle Detail:
 public Enumeration<String> getKeys() 
    Returns an Enumeration of the keys contained in this ResourceBundle and its parent bundles.
 public Object handleGetObject(String key) 
 protected Set<String> handleKeySet() 
    Returns a Set of the keys contained only in this ResourceBundle.