|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class PropertyResourceBundle
java.util.PropertyResourceBundle
public class 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
Implementation Requirements:
The implementation of a PropertyResourceBundle subclass must be
thread-safe if it's simultaneously used by multiple threads. The default
implementations of the non-abstract methods in this class are thread-safe.
Since:
1.1
See Also:
Nested classes/interfaces inherited from class java.util. ResourceBundle |
|
Constructor Summary |
Creates a property resource bundle from an InputStream.
|
Creates a property resource bundle from a Reader.
|
Method Summary |
|
Returns an Enumeration of the keys contained in
this ResourceBundle and its parent bundles.
|
|
Gets an object for the given key from this resource bundle.
|
|
Returns a Set of the keys contained
only in this ResourceBundle.
|
|
clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, keySet, setParent |
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public PropertyResourceBundle |
|
throws |
|
Creates a property resource bundle from an
InputStream. This constructor reads the property file in UTF-8 by default.
If a
MalformedInputException or an
UnmappableCharacterException occurs on reading the
input stream, then the PropertyResourceBundle instance resets to the state
before the exception, re-reads the input stream in
ISO-8859-1 and
continues reading. If the system property
java.util.PropertyResourceBundle.encoding is set to either
"ISO-8859-1" or "UTF-8", the input stream is solely read in that encoding,
and throws the exception if it encounters an invalid sequence. Other
encoding values are ignored for this system property.
The system property is read and evaluated when initializing this class.
Changing or removing the property has no effect after the initialization.
Parameters:
stream - an InputStream that represents a property file
to read from.
Throws:
IOException - if an I/O error occurs
MalformedInputException - if the system property
java.util.PropertyResourceBundle.encoding is set to "UTF-8"
and
stream contains an invalid UTF-8 byte sequence.
UnmappableCharacterException - if the system property
java.util.PropertyResourceBundle.encoding is set to "UTF-8"
and
stream contains an unmappable UTF-8 byte sequence.
public PropertyResourceBundle |
|
throws |
|
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 - a Reader that represents a property file to
read from.
Throws:
Since:
1.6
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.
Overrides:
Parameters:
key - the key for the desired object
Returns:
the object for the given key, or null
Returns an
Enumeration of the keys contained in
this
ResourceBundle and its parent bundles.
Overrides:
Returns:
an Enumeration of the keys contained in
this ResourceBundle and its parent bundles.
See Also:
Returns a
Set of the keys contained
only in this
ResourceBundle.
Overrides:
Returns:
a Set of the keys contained only in this
ResourceBundle
Since:
1.6
See Also:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz