com.redhat.rhn.common.localization

Class XmlResourceBundle

java.lang.Object

java.util.ResourceBundle

com.redhat.rhn.common.localization.XmlResourceBundle

public final class XmlResourceBundle
extends java.util.ResourceBundle

Class that extends the java.util.ResourceBundle class that stores the strings in an XML format similar to a property file.

The format is as follows:

 <messages>
   <msg id="getMessage">Get this</msg>
   <msg id="oneArg">one arg: {0}</msg>
   <msg id="twoArg">two arg: {0} {1}</msg>
   <msg id="threeArg">three arg: {0} {1} {2}</msg>
 </messages>
 

Where the bundle gets built with the keys being the "id" attribute of the XML tag and the values being contained within the value of the <msg> tag itself. Message substitution is supported.

Nested Class Summary

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

java.util.ResourceBundle.Control

Field Summary

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

Constructors

Constructor and Description
XmlResourceBundle() Constructor
XmlResourceBundle(java.lang.String filelocation) Creates a property resource bundle.

Method Summary

Modifier and Type	Method and Description
java.util.Enumeration<java.lang.String>	getKeys() ResourceBundle.getKeys() implemenatation
java.lang.Object	handleGetObject(java.lang.String key) Overrides the java.util.ResourceBundle.handleGetObject.

Methods inherited from class java.util.ResourceBundle

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlResourceBundle

public XmlResourceBundle()

Constructor

XmlResourceBundle

public XmlResourceBundle(java.lang.String filelocation)
                  throws java.io.IOException

Creates a property resource bundle.

Parameters:

filelocation - location of XML file to parse

Throws:

java.io.IOException - if the file can't be parsed/loaded

Method Detail

handleGetObject

public java.lang.Object handleGetObject(java.lang.String key)

Overrides the java.util.ResourceBundle.handleGetObject.

Specified by:

handleGetObject in class java.util.ResourceBundle

Parameters:

key - the key to lookup out of the bundle

Returns:

The value found. This will be a java.lang.String and can be cased accordingly.

getKeys

public java.util.Enumeration<java.lang.String> getKeys()

ResourceBundle.getKeys() implemenatation

Specified by:

getKeys in class java.util.ResourceBundle

Returns:

Enumeration of the keys contained in this bundle. Useful for searching for a partial match.