org.apache.fop.util

Class XMLResourceBundle

java.lang.Object

java.util.ResourceBundle

org.apache.fop.util.XMLResourceBundle

public class XMLResourceBundle
extends ResourceBundle

This class is a ResourceBundle that loads its contents from XML files instead of properties files (like PropertiesResourceBundle).

The XML format for this resource bundle implementation is the following (the same as Apache Cocoon's XMLResourceBundle):

 <catalogue xml:lang="en">
   <message key="key1">Message <br/> Value 1</message>
   <message key="key2">Message <br/> Value 1</message>
   ...
 </catalogue>
 

Nested Class Summary

Nested classes/interfaces inherited from class java.util.ResourceBundle

ResourceBundle.Control

Field Summary

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

Constructors

Constructor and Description
XMLResourceBundle(InputStream in) Creates a resource bundle from an InputStream.

Method Summary

Modifier and Type	Method and Description
Enumeration	getKeys()
Locale	getLocale()
static ResourceBundle	getXMLBundle(String baseName, ClassLoader loader) Gets a resource bundle using the specified base name, default locale, and class loader.
static ResourceBundle	getXMLBundle(String baseName, Locale locale, ClassLoader loader) Gets a resource bundle using the specified base name, locale, and class loader.
protected Object	handleGetObject(String key)
String	toString()

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getObject, getString, getStringArray, handleKeySet, keySet, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLResourceBundle

public XMLResourceBundle(InputStream in)
                  throws IOException

Creates a resource bundle from an InputStream.

Parameters:

in - the stream to read from

Throws:

IOException - if an I/O error occurs

Method Detail

getXMLBundle

public static ResourceBundle getXMLBundle(String baseName,
                                          ClassLoader loader)
                                   throws MissingResourceException

Gets a resource bundle using the specified base name, default locale, and class loader.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

loader - the class loader from which to load the resource bundle

Returns:

a resource bundle for the given base name and the default locale

Throws:

MissingResourceException - if no resource bundle for the specified base name can be found

See Also:

ResourceBundle.getBundle(String)

getXMLBundle

public static ResourceBundle getXMLBundle(String baseName,
                                          Locale locale,
                                          ClassLoader loader)
                                   throws MissingResourceException

Gets a resource bundle using the specified base name, locale, and class loader.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for which a resource bundle is desired

loader - the class loader from which to load the resource bundle

Returns:

a resource bundle for the given base name and locale

Throws:

MissingResourceException - if no resource bundle for the specified base name can be found

See Also:

ResourceBundle.getBundle(String, Locale, ClassLoader)

getLocale

public Locale getLocale()

Overrides:

getLocale in class ResourceBundle

getKeys

public Enumeration getKeys()

Specified by:

getKeys in class ResourceBundle

handleGetObject

protected Object handleGetObject(String key)

Specified by:

handleGetObject in class ResourceBundle

toString

public String toString()

Overrides:

toString in class Object