org.finra.herd.dao.helper

Class XmlHelper

java.lang.Object

org.finra.herd.dao.helper.XmlHelper

@Component
public class XmlHelper
extends Object

A helper class for XML functionality.

Constructor Summary

Constructors

Constructor and Description
XmlHelper()

Method Summary

Modifier and Type	Method and Description
static String	createPrettyPrint(String input) Reformat xml string to indented "pretty printed" view
String	objectToXml(Object obj) Returns XML representation of the object.
String	objectToXml(Object obj, boolean formatted) Returns XML representation of the object using the herd custom character escape handler.
<T> T	unmarshallXmlToObject(Class<T> classType, String xmlString) Unmarshalls the xml into JAXB object.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlHelper

public XmlHelper()

Method Detail

objectToXml

public String objectToXml(Object obj)
                   throws JAXBException

Returns XML representation of the object.

Parameters:

obj - the Java object to be serialized

Returns:

the XML representation of this object

Throws:

JAXBException - if a JAXB error occurred.

objectToXml

public String objectToXml(Object obj,
                          boolean formatted)
                   throws JAXBException

Returns XML representation of the object using the herd custom character escape handler.

Parameters:

obj - the Java object to be serialized

formatted - specifies whether or not the marshalled XML data is formatted with line feeds and indentation

Returns:

the XML representation of this object

Throws:

JAXBException - if a JAXB error occurred.

unmarshallXmlToObject

public <T> T unmarshallXmlToObject(Class<T> classType,
                                   String xmlString)
                            throws JAXBException

Unmarshalls the xml into JAXB object.

Type Parameters:

T - the class type.

Parameters:

classType - the class type of JAXB element

xmlString - the xml string

Returns:

the JAXB object

Throws:

JAXBException - if there is an error in unmarshalling

createPrettyPrint

public static String createPrettyPrint(String input)
                                throws TransformerFactoryConfigurationError,
                                       TransformerException

Reformat xml string to indented "pretty printed" view

Parameters:

input - the xml string to be reformatted

Returns:

the reformatted multiline xml representation

Throws:

TransformerFactoryConfigurationError - in case of TransformerFactory configuration error or if the implementation is not available or cannot be instantiated.

TransformerException - when unable to perform indent transformation