stanford.cs106.util

Class XmlUtils

java.lang.Object

stanford.cs106.util.XmlUtils

public class XmlUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlUtils.XmlRuntimeException Represents exceptions that can occur while processing XML text.

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_EXTENSION

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	attributeIsFalsey(Node node, String name)
static boolean	attributeIsTruthy(Node node, String name)
static void	ensureNotNull(Object node, String tag)
static String	getAttribute(Node node, String name) Returns the value of the attribute of the given node with the given name.
static String	getAttribute(Node node, String name, boolean required)
static String	getAttribute(Node node, String name, boolean required, String defaultValue)
static String	getAttributeAny(Node node, boolean required, String... names) Returns the value of the first attribute found with any of the given names, else null.
static String	getAttributeAny(Node node, String... names) Returns the value of the first attribute found with any of the given names, else null.
static int	getAttributeInt(Node node, String name)
static int	getAttributeInt(Node node, String name, boolean required)
static int	getAttributeInt(Node node, String name, boolean required, int defaultValue)
static String	getAttributeOrChild(Node node, String name)
static String	getAttributeOrChild(Node node, String name, boolean required) Returns the value of the attribute of the given node with the given name.
static List<String>	getAttributes(Node node) Returns all attributes of the given XML node as a list of name=value strings.
static Node	getChildByTagName(Node node, String element)
static Node	getChildByTagName(Node node, String element, boolean required)
static Node	getChildNode(Node node, String element)
static List<Node>	getChildNodes(Node node, String... elements)
static List<Node>	getChildrenByTagName(Node node, String element)
static List<Node>	getChildrenByTagNames(Node node, String... elements)
static String	getChildValue(Node node, String element)
static String	getChildValue(Node node, String element, boolean required)
static Element	getElementByTagName(Document document, String element)
static String	getTextContent(Node node)
static String	getTextContent(Node node, boolean trim)
static boolean	hasAttribute(Node node, String name) Returns whether the given XML DOM node contains the given attribute.
static boolean	hasAttributeAny(Node node, String... names) Returns the value of the first attribute found with any of the given names, else null.
static boolean	hasAttributes(Node node, String... names) Returns whether the given XML DOM node contains all of the given attributes.
static void	requireAttributes(Node node, String... names) Ensures that the given XML DOM node contains all of the given attributes.
static void	setAttribute(Node node, String name, String value)
static Node	up(Node node, String element)
static void	validate(String xmlFileName, String schemaFileName)

Methods inherited from class java.lang.Object

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

Field Detail

XML_EXTENSION

public static final String XML_EXTENSION

See Also:

Constant Field Values

Constructor Detail

XmlUtils

public XmlUtils()

Method Detail

attributeIsFalsey

public static boolean attributeIsFalsey(Node node,
                                        String name)

attributeIsTruthy

public static boolean attributeIsTruthy(Node node,
                                        String name)

ensureNotNull

public static void ensureNotNull(Object node,
                                 String tag)

getAttribute

public static String getAttribute(Node node,
                                  String name)

Returns the value of the attribute of the given node with the given name.

Parameters:

node - the XML node to examine

name - the attribute name for which to retrieve the value

Returns:

the attribute value, or null if the attribute does not exist for this node

setAttribute

public static void setAttribute(Node node,
                                String name,
                                String value)

getAttribute

public static String getAttribute(Node node,
                                  String name,
                                  boolean required)

getAttribute

public static String getAttribute(Node node,
                                  String name,
                                  boolean required,
                                  String defaultValue)

getAttributeInt

public static int getAttributeInt(Node node,
                                  String name)

getAttributeInt

public static int getAttributeInt(Node node,
                                  String name,
                                  boolean required)

getAttributeInt

public static int getAttributeInt(Node node,
                                  String name,
                                  boolean required,
                                  int defaultValue)

getAttributeAny

public static String getAttributeAny(Node node,
                                     String... names)

Returns the value of the first attribute found with any of the given names, else null.

Parameters:

node - the XML node to examine

Returns:

the attribute value, or null if the attribute does not exist for this node

getAttributeAny

public static String getAttributeAny(Node node,
                                     boolean required,
                                     String... names)

Returns the value of the first attribute found with any of the given names, else null.

Parameters:

node - the XML node to examine

Returns:

the attribute value, or null if the attribute does not exist for this node

getAttributeOrChild

public static String getAttributeOrChild(Node node,
                                         String name)

getAttributeOrChild

public static String getAttributeOrChild(Node node,
                                         String name,
                                         boolean required)

Returns the value of the attribute of the given node with the given name.

Parameters:

node - the XML node to examine

name - the attribute name for which to retrieve the value

Returns:

the attribute value, or null if the attribute does not exist for this node

getAttributes

public static List<String> getAttributes(Node node)

Returns all attributes of the given XML node as a list of name=value strings. Mostly just for debugging.

Parameters:

node -

Returns:

getChildNode

public static Node getChildNode(Node node,
                                String element)

getChildNodes

public static List<Node> getChildNodes(Node node,
                                       String... elements)

getChildValue

public static String getChildValue(Node node,
                                   String element)

getChildValue

public static String getChildValue(Node node,
                                   String element,
                                   boolean required)

getChildByTagName

public static Node getChildByTagName(Node node,
                                     String element,
                                     boolean required)

getChildByTagName

public static Node getChildByTagName(Node node,
                                     String element)

getChildrenByTagName

public static List<Node> getChildrenByTagName(Node node,
                                              String element)

getChildrenByTagNames

public static List<Node> getChildrenByTagNames(Node node,
                                               String... elements)

getElementByTagName

public static Element getElementByTagName(Document document,
                                          String element)

getTextContent

public static String getTextContent(Node node)

getTextContent

public static String getTextContent(Node node,
                                    boolean trim)

hasAttribute

public static boolean hasAttribute(Node node,
                                   String name)

Returns whether the given XML DOM node contains the given attribute.

Parameters:

node - the XML node to examine

name - an attribute name to check

Returns:

true if the attribute exists, false if not

hasAttributeAny

public static boolean hasAttributeAny(Node node,
                                      String... names)

Returns the value of the first attribute found with any of the given names, else null.

Parameters:

node - the XML node to examine

Returns:

the attribute value, or null if the attribute does not exist for this node

hasAttributes

public static boolean hasAttributes(Node node,
                                    String... names)

Returns whether the given XML DOM node contains all of the given attributes.

Parameters:

node - the XML node to examine

names - a variable-length list of attribute names to check

Returns:

true if all attributes exist, false if not

requireAttributes

public static void requireAttributes(Node node,
                                     String... names)

Ensures that the given XML DOM node contains all of the given attributes. Throws an exception if any attribute is not found.

Parameters:

node - the XML node to examine

names - a variable-length list of attribute names to check

Throws:

XMLStreamException - if any attribute is not found

validate

public static void validate(String xmlFileName,
                            String schemaFileName)
                     throws IOException,
                            ParserConfigurationException,
                            SAXException

Throws:

IOException

ParserConfigurationException

SAXException

up

public static Node up(Node node,
                      String element)