eu.fthevenet.util.xml

Class XmlUtils

java.lang.Object

eu.fthevenet.util.xml.XmlUtils

public class XmlUtils
extends java.lang.Object

A collections of convenience methods to help with serialization and deserialization of XML to and from Java objects.

Author:

Frederic Thevenet

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Modifier and Type	Method and Description
static <T> T	deSerialize(java.lang.Class<T> docClass, java.io.File file)
static <T> T	deSerialize(java.lang.Class<T> docClass, java.io.InputStream inputStream) Deserialize the XML content of a stream into a Java object of the specified type.
static <T> T	deSerialize(java.lang.Class<T> docClass, java.lang.String xmlString) Deserialize the XML content of a string into a Java object of the specified type.
static java.lang.String	getFirstAttributeValue(java.io.File file, java.lang.String attribute)
static <T> void	serialize(T object, java.io.File file)
static <T> void	serialize(T object, java.io.OutputStream out)
static <T> void	serialize(T object, java.nio.file.Path path)
static javax.xml.transform.Source	toNonValidatingSAXSource(java.io.InputStream in) Returns a SAXSource for the provided InputStream that explicitly forfeit external DTD validation

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlUtils

public XmlUtils()

Method Detail

getFirstAttributeValue

public static java.lang.String getFirstAttributeValue(java.io.File file,
                                                      java.lang.String attribute)
                                               throws java.io.IOException,
                                                      javax.xml.stream.XMLStreamException

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

deSerialize

public static <T> T deSerialize(java.lang.Class<T> docClass,
                                java.io.File file)
                         throws javax.xml.bind.JAXBException,
                                java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

deSerialize

public static <T> T deSerialize(java.lang.Class<T> docClass,
                                java.io.InputStream inputStream)
                         throws javax.xml.bind.JAXBException

Deserialize the XML content of a stream into a Java object of the specified type.

Type Parameters:

T - The type of object to unmarshall the XML as

Parameters:

docClass - The class of the object to unmarshall the XML as

inputStream - An input stream containing the XML to deserialize

Returns:

The deserialized object

Throws:

javax.xml.bind.JAXBException - if an error occurs during deserialization

deSerialize

public static <T> T deSerialize(java.lang.Class<T> docClass,
                                java.lang.String xmlString)
                         throws javax.xml.bind.JAXBException

Deserialize the XML content of a string into a Java object of the specified type.

Type Parameters:

T - The type of object to unmarshall the XML as

Parameters:

docClass - The class of the object to unmarshall the XML as

xmlString - The XML to deserialize, as a string

Returns:

The deserialized object

Throws:

javax.xml.bind.JAXBException - if an error occurs during deserialization

toNonValidatingSAXSource

public static javax.xml.transform.Source toNonValidatingSAXSource(java.io.InputStream in)
                                                           throws org.xml.sax.SAXException,
                                                                  javax.xml.parsers.ParserConfigurationException

Returns a SAXSource for the provided InputStream that explicitly forfeit external DTD validation

Parameters:

in - the InputStream for the SAXSource

Returns:

a SAXSource for the provided InputStream that explicitly forfeit external DTD validation

Throws:

org.xml.sax.SAXException - if a SAX error occurs

javax.xml.parsers.ParserConfigurationException - if a configuration error occurs

serialize

public static <T> void serialize(T object,
                                 java.nio.file.Path path)
                          throws javax.xml.bind.JAXBException,
                                 java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

serialize

public static <T> void serialize(T object,
                                 java.io.File file)
                          throws javax.xml.bind.JAXBException,
                                 java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

serialize

public static <T> void serialize(T object,
                                 java.io.OutputStream out)
                          throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException