com.cloudbees.clickstack.util

Class XmlUtils

java.lang.Object

com.cloudbees.clickstack.util.XmlUtils

public class XmlUtils
extends Object

XML Utils.

Author:

Cyrille Le Clerc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlUtils.TransformerRuntimeException Runtime version of TransformerException

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkRootElement(Document document, String expectedRootElementName) Check that the name of root element of the given document matches the given expectedRootElementName
static String	flush(Document in) Serialise the given Document into a String.
static void	flush(Document in, OutputStream out) Serialise the given Document in the given OutputStream.
static void	flush(Document in, OutputStream out, Map<String,String> outputProperties) Serialise the given Document in the given OutputStream.
static void	flush(Document in, Result out, Map<String,String> outputProperties) Serialise the given Document in the given Result.
static void	flush(Document in, Writer out) Serialise the given Document in the given Writer.
static void	flush(Document in, Writer out, Map<String,String> outputProperties) Serialise the given Document in the given Writer.
static String	flush(Node in) Serialise the given Document into a String.
static void	flush(Node in, OutputStream out) Serialise the given Node in the given OutputStream.
static void	flush(Node in, OutputStream out, Map<String,String> outputProperties) Serialise the given Node in the given OutputStream.
static void	flush(Node in, Result out, Map<String,String> outputProperties) Serialise the given Node in the given Result.
static void	flush(Node in, Writer out) Serialise the given Node in the given Writer.
static void	flush(Node in, Writer out, Map<String,String> outputProperties) Serialise the given Node in the given Writer.
static Element	getUniqueElement(Document document, String xpathExpression) Returns the unique XML element matching the given xpathExpression
static Element	getUniqueElement(Element element, String xpathExpression) Returns the unique XML element matching the given xpathExpression
static Element	getUniqueElement(Node node, String xpathExpression) Returns the unique XML element matching the given xpathExpression
static void	insertSiblingAfter(Element newElement, Element sibling) Insert the given newElement just next to the given sibling, after it.
static Document	loadXmlDocumentFromFile(File file) Load the given file as an XML document.
static Document	loadXmlDocumentFromPath(Path path) Load the given path as an XML document.
static Document	loadXmlDocumentFromStream(InputStream in) Load the given InputStream as an XML document.
static void	setElementTextContent(Element element, String xpath, String value)

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

getUniqueElement

@Nonnull
public static Element getUniqueElement(@Nonnull
                               Document document,
                               @Nonnull
                               String xpathExpression)
                                throws RuntimeException

Returns the unique XML element matching the given xpathExpression

Parameters:

document -

xpathExpression - xpath expression to find the element

Returns:

the matching element

Throws:

RuntimeException - 0 or more than 1 matching element found

getUniqueElement

@Nonnull
public static Element getUniqueElement(@Nonnull
                               Element element,
                               @Nonnull
                               String xpathExpression)

Returns the unique XML element matching the given xpathExpression

Parameters:

element -

xpathExpression - xpath expression to find the element

Returns:

the matching element

Throws:

RuntimeException - 0 or more than 1 matching element found

getUniqueElement

@Nonnull
public static Element getUniqueElement(@Nonnull
                               Node node,
                               @Nonnull
                               String xpathExpression)

Returns the unique XML element matching the given xpathExpression

Parameters:

node -

xpathExpression - xpath expression to find the node

Returns:

the matching node

Throws:

RuntimeException - 0 or more than 1 matching element found

loadXmlDocumentFromFile

@Nonnull
public static Document loadXmlDocumentFromFile(@Nonnull
                                       File file)
                                        throws ParserConfigurationException,
                                               IOException,
                                               SAXException

Load the given file as an XML document.

Parameters:

file -

Returns:

the loaded XML document

Throws:

ParserConfigurationException

IOException

SAXException

loadXmlDocumentFromPath

@Nonnull
public static Document loadXmlDocumentFromPath(@Nonnull
                                       Path path)
                                        throws ParserConfigurationException,
                                               IOException,
                                               SAXException

Load the given path as an XML document.

Parameters:

path -

Returns:

the loaded XML document

Throws:

ParserConfigurationException

IOException

SAXException

loadXmlDocumentFromStream

@Nonnull
public static Document loadXmlDocumentFromStream(@Nonnull
                                         InputStream in)
                                          throws ParserConfigurationException,
                                                 IOException,
                                                 SAXException

Load the given InputStream as an XML document.

Parameters:

in -

Returns:

the loaded XML document

Throws:

ParserConfigurationException

IOException

SAXException

checkRootElement

public static void checkRootElement(@Nonnull
                    Document document,
                    @Nullable
                    String expectedRootElementName)

Check that the name of root element of the given document matches the given expectedRootElementName

Parameters:

document -

expectedRootElementName -

flush

@Nonnull
public static String flush(@Nonnull
                   Document in)
                    throws XmlUtils.TransformerRuntimeException

Serialise the given Document into a String.

Parameters:

in -

Returns:

serialized XML

Throws:

XmlUtils.TransformerRuntimeException

flush

@Nonnull
public static String flush(@Nonnull
                   Node in)
                    throws XmlUtils.TransformerRuntimeException

Serialise the given Document into a String.

Parameters:

in -

Returns:

serialized XML

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Document in,
         @Nonnull
         OutputStream out)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Document in the given OutputStream.

Parameters:

in -

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Node in,
         @Nonnull
         OutputStream out)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Node in the given OutputStream.

Parameters:

in -

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Document in,
         @Nonnull
         Writer out)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Document in the given Writer.

Parameters:

in -

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Node in,
         @Nonnull
         Writer out)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Node in the given Writer.

Parameters:

in -

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Document in,
         @Nonnull
         OutputStream out,
         @Nullable
         Map<String,String> outputProperties)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Document in the given OutputStream.

Parameters:

in -

outputProperties - see Transformer.setOutputProperty(String, String)

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Node in,
         @Nonnull
         OutputStream out,
         @Nullable
         Map<String,String> outputProperties)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Node in the given OutputStream.

Parameters:

in -

outputProperties - see Transformer.setOutputProperty(String, String)

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Document in,
         @Nonnull
         Writer out,
         @Nullable
         Map<String,String> outputProperties)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Document in the given Writer.

Parameters:

in -

outputProperties - see Transformer.setOutputProperty(String, String)

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Node in,
         @Nonnull
         Writer out,
         @Nullable
         Map<String,String> outputProperties)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Node in the given Writer.

Parameters:

in -

outputProperties - see Transformer.setOutputProperty(String, String)

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Document in,
         @Nonnull
         Result out,
         @Nullable
         Map<String,String> outputProperties)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Document in the given Result.

Parameters:

in -

outputProperties - see Transformer.setOutputProperty(String, String)

out -

Throws:

XmlUtils.TransformerRuntimeException

flush

public static void flush(@Nonnull
         Node in,
         @Nonnull
         Result out,
         @Nullable
         Map<String,String> outputProperties)
                  throws XmlUtils.TransformerRuntimeException

Serialise the given Node in the given Result.

Parameters:

in -

outputProperties - see Transformer.setOutputProperty(String, String)

out -

Throws:

XmlUtils.TransformerRuntimeException

insertSiblingAfter

public static void insertSiblingAfter(@Nonnull
                      Element newElement,
                      @Nonnull
                      Element sibling)

Insert the given newElement just next to the given sibling, after it.

Parameters:

newElement -

sibling -

setElementTextContent

public static void setElementTextContent(@Nonnull
                         Element element,
                         @Nonnull
                         String xpath,
                         @Nullable
                         String value)

Parameters:

element - root element to locate the element to modify

xpath - xpath expression to locate the element to modify

value - no value of the element