org.exoplatform.services.resources

Class XMLResourceBundleParser

java.lang.Object

org.exoplatform.services.resources.XMLResourceBundleParser

public class XMLResourceBundleParser
extends Object

A parser for XML resource bundle having the following rules:

• The root document element is named "bundle"
• Any non root element can have any name
• Any non root element content must not have mixed content (i.e text and children elements)
• Any element having textual content is considered as a bundle entry with they key formed by the dot concatenation of its parent element name except the root element and the value is the text content

For instance the following document: <bundle> <foo> <A>1<A> <B>2<B> </foo> <C>3<C> </bundle> will give the bundle with entries:

• foo.A=1
• foo.B=2
• C=3

Version:

$Revision$

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
XMLResourceBundleParser()

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	asMap(InputSource in) Load an xml resource bundle as a Map<String,String> object.
static Map<String,String>	asMap(InputStream in)
static Map<String,String>	asMap(Reader in)
static Properties	asProperties(InputSource in)
static Properties	asProperties(InputStream in)
static Properties	asProperties(Reader in)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLResourceBundleParser

public XMLResourceBundleParser()

Method Detail

asProperties

public static Properties asProperties(InputStream in)
                               throws IOException,
                                      SAXException,
                                      ParserConfigurationException,
                                      IllegalArgumentException

Throws:

IOException

SAXException

ParserConfigurationException

IllegalArgumentException

See Also:

asMap(org.xml.sax.InputSource)

asProperties

public static Properties asProperties(Reader in)
                               throws IOException,
                                      SAXException,
                                      ParserConfigurationException,
                                      IllegalArgumentException

Throws:

IOException

SAXException

ParserConfigurationException

IllegalArgumentException

See Also:

asMap(org.xml.sax.InputSource)

asProperties

public static Properties asProperties(InputSource in)
                               throws IOException,
                                      SAXException,
                                      ParserConfigurationException,
                                      IllegalArgumentException

Throws:

IOException

SAXException

ParserConfigurationException

IllegalArgumentException

See Also:

asMap(org.xml.sax.InputSource)

asMap

public static Map<String,String> asMap(InputStream in)
                                throws IOException,
                                       SAXException,
                                       ParserConfigurationException,
                                       IllegalArgumentException

Throws:

IOException

SAXException

ParserConfigurationException

IllegalArgumentException

See Also:

asMap(org.xml.sax.InputSource)

asMap

public static Map<String,String> asMap(Reader in)
                                throws IOException,
                                       SAXException,
                                       ParserConfigurationException,
                                       IllegalArgumentException

Throws:

IOException

SAXException

ParserConfigurationException

IllegalArgumentException

See Also:

asMap(org.xml.sax.InputSource)

asMap

public static Map<String,String> asMap(InputSource in)
                                throws IOException,
                                       SAXException,
                                       ParserConfigurationException,
                                       IllegalArgumentException

Load an xml resource bundle as a Map<String,String> object.

Parameters:

in - the input source

Returns:

the properties object

Throws:

IOException - any IOException

SAXException - any SAXException

ParserConfigurationException - any ParserConfigurationException

IllegalArgumentException - if the argument is null