org.dynamide.util

Class XmlTools

java.lang.Object

org.dynamide.util.XmlTools

public class XmlTools
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.dom4j.io.OutputFormat	PRETTY_PRINT_OUTPUT_FORMAT

Constructor Summary

Constructors

Constructor and Description
XmlTools()

Method Summary

Modifier and Type	Method and Description
static void	closeQuietly(Closeable c) Attempt to close a resource, swallowing any Exceptions thrown.
protected static org.dom4j.io.OutputFormat	defaultPrettyPrintOutputFormat() Returns a default output format for pretty printing an XML document.
static org.dom4j.Document	fileToXMLDocument(File file) Returns a dom4j XML document, when provided with a file containing a well-formed XML document.
static String	formatXML(org.dom4j.Document doc, org.dom4j.io.OutputFormat outformat) Returns a String representation of an XML document, formatted according to a specified output format.
static String	getElementValue(org.dom4j.Document doc, String xpathExpr) Returns the (text node) value of a specified element in a dom4j XML document.
static void	main(String[] args)
static String	payloadJSONtoXML(String payload)
static String	payloadJSONtoXML(String payload, String rootName)
static String	payloadXMLtoJSON_RestReplay(String payload)
static String	payloadXMLtoJSON(String payload)
static String	payloadXMLtoJSON(String payload, String removeRoot) For example, use removeRoot="root", which will look for an XML root element named "root", or pass "" to get everything, including the root node itself.
static String	prettyPrint(org.dom4j.Document document)
static String	prettyPrint(org.dom4j.Document document, String indentString)
static String	prettyPrint(String xml)
static String	prettyPrintXML(org.dom4j.Document doc) Returns a pretty printed String representation of an XML document.
static org.dom4j.Document	setAttributeValue(org.dom4j.Document doc, String xpathExpr, String attributeName, String attributeValue) Sets the value of a specified attribute in a dom4j XML document.
static org.dom4j.Document	setElementValue(org.dom4j.Document doc, String xpathExpr, String elementValue) Sets the (text node) value of a specified element in a dom4j XML document.
static org.dom4j.Document	textToXMLDocument(String xmlStr) Returns a dom4j XML document, when provided with a String representation of that XML document.
static void	xmlDocumentToFile(org.dom4j.Document doc, File file) Writes a dom4j XML document to a file on disk.

Methods inherited from class java.lang.Object

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

Field Detail

PRETTY_PRINT_OUTPUT_FORMAT

public static final org.dom4j.io.OutputFormat PRETTY_PRINT_OUTPUT_FORMAT

Constructor Detail

XmlTools

public XmlTools()

Method Detail

defaultPrettyPrintOutputFormat

protected static org.dom4j.io.OutputFormat defaultPrettyPrintOutputFormat()

Returns a default output format for pretty printing an XML document. Uses the default settings for indentation, whitespace, etc. of a pre-defined dom4j output format.

Returns:

A default output format for pretty printing an XML document.

prettyPrintXML

public static String prettyPrintXML(org.dom4j.Document doc)

Returns a pretty printed String representation of an XML document.

Parameters:

doc - A dom4j XML Document.

Returns:

A pretty printed String representation of an XML document.

formatXML

public static String formatXML(org.dom4j.Document doc,
                               org.dom4j.io.OutputFormat outformat)
                        throws Exception

Returns a String representation of an XML document, formatted according to a specified output format.

Parameters:

doc - A dom4j XML Document.

outformat - A dom4j output format.

Returns:

A String representation of an XML document, formatted according to the specified output format.

Throws:

Exception - if an error occurs in printing the XML document to a String.

textToXMLDocument

public static org.dom4j.Document textToXMLDocument(String xmlStr)
                                            throws Exception

Returns a dom4j XML document, when provided with a String representation of that XML document.

Parameters:

xmlStr - A String representation of an XML document.

Returns:

A dom4j XML document.

Throws:

Exception

fileToXMLDocument

public static org.dom4j.Document fileToXMLDocument(File file)
                                            throws Exception

Returns a dom4j XML document, when provided with a file containing a well-formed XML document.

Parameters:

file - A file containing a well-formed XML document.

Returns:

A dom4j XML document.

Throws:

Exception

xmlDocumentToFile

public static void xmlDocumentToFile(org.dom4j.Document doc,
                                     File file)
                              throws Exception

Writes a dom4j XML document to a file on disk. Uses UTF-8 character encoding.

Parameters:

doc - A dom4j XML document.

file - A file.

Throws:

Exception

closeQuietly

public static void closeQuietly(Closeable c)

Attempt to close a resource, swallowing any Exceptions thrown. This method should only be called from within the 'finally' portion of a 'catch/try/finally' block. See http://stackoverflow.com/questions/2699209/java-io-ugly-try-finally-block and http://stackoverflow.com/questions/341971/what-is-the-execute-around-idiom

Parameters:

c - A closeable resource.

getElementValue

public static String getElementValue(org.dom4j.Document doc,
                                     String xpathExpr)

Returns the (text node) value of a specified element in a dom4j XML document.

Parameters:

doc - A dom4j XML document.

xpathExpr - An XPath expression intended to match a single element in the XML document, in the default namespace.

Returns:

The (text node) value of the matched element, if any.

setElementValue

public static org.dom4j.Document setElementValue(org.dom4j.Document doc,
                                                 String xpathExpr,
                                                 String elementValue)

Sets the (text node) value of a specified element in a dom4j XML document.

Parameters:

doc - A dom4j XML document.

xpathExpr - An XPath expression intended to match a single element in the XML document, in the default namespace.

elementValue - The value that the element should contain. If this provided value is null, the element's value will be set to an empty string.

Returns:

The document with the (text node) value of the matched element, if any, set to the provided value.

setAttributeValue

public static org.dom4j.Document setAttributeValue(org.dom4j.Document doc,
                                                   String xpathExpr,
                                                   String attributeName,
                                                   String attributeValue)

Sets the value of a specified attribute in a dom4j XML document.

Parameters:

doc - A dom4j XML document.

xpathExpr - An XPath expression intended to match a single element in the XML document, in the default namespace.

attributeName - An attribute name.

attributeValue - The value that the attribute should contain.

Returns:

The document with the specified attribute of the matched element, if any, set to the provided value. If the attribute doesn't already exist, it will be created and assigned the provided value.

prettyPrint

public static String prettyPrint(String xml)
                          throws Exception

Throws:

Exception

prettyPrint

public static String prettyPrint(org.dom4j.Document document)

prettyPrint

public static String prettyPrint(org.dom4j.Document document,
                                 String indentString)

payloadJSONtoXML

public static String payloadJSONtoXML(String payload)

payloadJSONtoXML

public static String payloadJSONtoXML(String payload,
                                      String rootName)

payloadXMLtoJSON_RestReplay

public static String payloadXMLtoJSON_RestReplay(String payload)

payloadXMLtoJSON

public static String payloadXMLtoJSON(String payload)

payloadXMLtoJSON

public static String payloadXMLtoJSON(String payload,
                                      String removeRoot)

For example, use removeRoot="root", which will look for an XML root element named "root", or pass "" to get everything, including the root node itself.

main

public static void main(String[] args)