de.javagl.common.xml

Class XmlUtils

java.lang.Object

de.javagl.common.xml.XmlUtils

public class XmlUtils
extends Object

Utility methods related to XML handling

Method Summary

Modifier and Type	Method and Description
static Node	createTextNode(String tagName, Object contents) Creates an XML node from the default document whose only child is a text node that contains the string representation of the given object
static String	getAttributeValue(Node node, String attributeName, String defaultValue) Returns the attribute with the given name from the given node.
static List<Node>	getChildren(Node node, String childNodeName) Returns the children of the given node with the given name (ignoring upper/lower case).
static Document	getDefaultDocument() Returns a default XML document
static Node	getFirstChild(Node node, String childNodeName) Returns the first child of the given node with the given name (ignoring upper/lower case), or null if no such child is found.
static String	getRequiredAttributeValue(Node node, String attributeName) Returns the attribute with the given name from the given node.
static Node	read(InputStream inputStream) Creates an XML node by reading the contents of the given input stream.
static boolean	readBooleanChild(Node node, String childNodeName, boolean defaultValue) Read an boolean value from the first child of the given node with the given name.
static <E extends Enum<E>> E	readEnumChild(Node node, Class<E> enumClass, String childNodeName) Parse an enum value from the first child of the given node with the given name
static int	readIntChild(Node node, String childNodeName, int defaultValue) Read an int value from the first child of the given node with the given name.
static String	toString(Node node) Creates a formatted String representation of the given XML node, including the XML declaration
static String	toString(Node node, int indentation, boolean omitXmlDeclaration) Creates a String representation of the given XML node
static void	verifyNode(Node node, String expected) Verify that the given node is not null, and that its name matches the expected tag name (ignoring upper/lowercase), and throw an XmlException if this is not the case.
static void	write(Node node, OutputStream outputStream) Writes a formatted String representation of the given XML node, including the XML declaration, to the given output stream.
static void	write(Node node, OutputStream outputStream, int indentation, boolean omitXmlDeclaration) Writes a formatted String representation of the given XML node, including the XML declaration, to the given output stream.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultDocument

public static Document getDefaultDocument()

Returns a default XML document

Returns:

The default XML document

toString

public static String toString(Node node)

Creates a formatted String representation of the given XML node, including the XML declaration

Parameters:

node - The node

Returns:

The formatted String representation of the given node

Throws:

XmlException - If there was an error while writing. This should never be the case for this method, because the XML is written into a String, and no exceptional situation (like IOException) can happen here.

toString

public static String toString(Node node,
                              int indentation,
                              boolean omitXmlDeclaration)

Creates a String representation of the given XML node

Parameters:

node - The node

indentation - The indentation. If this is not positive, then no indentation will be performed

omitXmlDeclaration - Whether the XML declaration should be omitted

Returns:

The formatted String representation of the given node

Throws:

XmlException - If there was an error while writing. This should never be the case for this method, because the XML is written into a String, and no exceptional situation (like IOException) can happen here.

write

public static void write(Node node,
                         OutputStream outputStream)

Writes a formatted String representation of the given XML node, including the XML declaration, to the given output stream. The caller is responsible for closing the given stream.

Parameters:

node - The node

outputStream - The output stream to write to

Throws:

XmlException - If there was an error while writing

write

public static void write(Node node,
                         OutputStream outputStream,
                         int indentation,
                         boolean omitXmlDeclaration)

Writes a formatted String representation of the given XML node, including the XML declaration, to the given output stream. The caller is responsible for closing the given stream.

Parameters:

node - The node

outputStream - The output stream to write to

indentation - The indentation. If this is not positive, then no indentation will be performed

omitXmlDeclaration - Whether the XML declaration should be omitted

Throws:

XmlException - If there was an error while writing

read

public static Node read(InputStream inputStream)
                 throws XmlException

Creates an XML node by reading the contents of the given input stream.

Parameters:

inputStream - The input stream to read from

Returns:

The parsed node

Throws:

XmlException - If there was an error while reading

createTextNode

public static Node createTextNode(String tagName,
                                  Object contents)

Creates an XML node from the default document whose only child is a text node that contains the string representation of the given object

Parameters:

tagName - The tag name for the node

contents - The object whose string representation will be the contents of the text node

Returns:

The node

getAttributeValue

public static String getAttributeValue(Node node,
                                       String attributeName,
                                       String defaultValue)

Returns the attribute with the given name from the given node. If the respective attribute could not be obtained, the given default value will be returned

Parameters:

node - The node to obtain the attribute from

attributeName - The name of the attribute

defaultValue - The default value to return when the specified attribute could not be obtained

Returns:

The value of the attribute, or the default value

getRequiredAttributeValue

public static String getRequiredAttributeValue(Node node,
                                               String attributeName)

Returns the attribute with the given name from the given node.

Parameters:

node - The node to obtain the attribute from

attributeName - The name of the attribute

Returns:

The value of the attribute

Throws:

XmlException - If no value of the attribute with the given name could be obtained.

getFirstChild

public static Node getFirstChild(Node node,
                                 String childNodeName)

Returns the first child of the given node with the given name (ignoring upper/lower case), or null if no such child is found.

Parameters:

node - The node

childNodeName - The child node name

Returns:

The child with the given name, or null

getChildren

public static List<Node> getChildren(Node node,
                                     String childNodeName)

Returns the children of the given node with the given name (ignoring upper/lower case).

Parameters:

node - The node

childNodeName - The child node name

Returns:

The children with the given name

verifyNode

public static void verifyNode(Node node,
                              String expected)

Verify that the given node is not null, and that its name matches the expected tag name (ignoring upper/lowercase), and throw an XmlException if this is not the case.

Parameters:

node - The node

expected - The expected tag name

Throws:

XmlException - If the node is null, or the node name does not match the expected name

readIntChild

public static int readIntChild(Node node,
                               String childNodeName,
                               int defaultValue)

Read an int value from the first child of the given node with the given name. If no such child is found, then the default value will be returned.

Parameters:

node - The node

childNodeName - The child node name

defaultValue - The default value

Returns:

The int value

Throws:

XmlException - If the given node was null, or no int value could be parsed

readBooleanChild

public static boolean readBooleanChild(Node node,
                                       String childNodeName,
                                       boolean defaultValue)

Read an boolean value from the first child of the given node with the given name. If no such child is found, then the default value will be returned.

Parameters:

node - The node

childNodeName - The child node name

defaultValue - The default value

Returns:

The boolean value

Throws:

XmlException - If the given node was null

readEnumChild

public static <E extends Enum<E>> E readEnumChild(Node node,
                                                  Class<E> enumClass,
                                                  String childNodeName)

Parse an enum value from the first child of the given node with the given name

Type Parameters:

E - The enum type

Parameters:

node - The node

enumClass - The enum class

childNodeName - The child node name

Returns:

The enum value

Throws:

XmlException - If the given node was null, or no enum value could be parsed