com.mopub.mobileads.util

Class XmlUtils

java.lang.Object

com.mopub.mobileads.util.XmlUtils

public class XmlUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XmlUtils.NodeProcessor<T>

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getAttributeValue(org.w3c.dom.Node node, java.lang.String attributeName)
static java.lang.Integer	getAttributeValueAsInt(org.w3c.dom.Node node, java.lang.String attributeName)
static <T> T	getFirstMatchFromDocument(org.w3c.dom.Document vastDoc, java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue, XmlUtils.NodeProcessor<T> nodeProcessor) Get first matching data from a Document]'s elements that match the {@code elementName}, {@code attributeName}, and {@code attributeValue} filters.
static org.w3c.dom.Node	getFirstMatchingChildNode(org.w3c.dom.Node node, java.lang.String nodeName) Gets the first direct child of the given node with a node named nodeName.
static org.w3c.dom.Node	getFirstMatchingChildNode(org.w3c.dom.Node node, java.lang.String nodeName, java.lang.String attributeName, java.util.List<java.lang.String> attributeValues) Gets the first direct child of the given node with a node named nodeName that has an attribute named attributeName with a value that matches one of attributeValues.
static java.lang.String	getFirstMatchingStringData(org.w3c.dom.Document vastDoc, java.lang.String elementName)
static java.lang.String	getFirstMatchingStringData(org.w3c.dom.Document vastDoc, java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue)
static <T> java.util.List<T>	getListFromDocument(org.w3c.dom.Document vastDoc, java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue, XmlUtils.NodeProcessor<T> nodeProcessor) Get a list of data from a Document]'s elements that match the {@code elementName}, {@code attributeName}, and {@code attributeValue} filters.
static java.util.List<org.w3c.dom.Node>	getMatchingChildNodes(org.w3c.dom.Node node, java.lang.String nodeName) Return children of the node parameter with a matching nodeName.
static java.util.List<org.w3c.dom.Node>	getMatchingChildNodes(org.w3c.dom.Node node, java.lang.String nodeName, java.lang.String attributeName, java.util.List<java.lang.String> attributeValues) Return children of the node parameter with a matching nodeName & attributeName that matches at least one of the passed-in attributeValues.
static java.util.List<org.w3c.dom.Node>	getNodesWithElementAndAttribute(org.w3c.dom.Document vastDoc, java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue)
static java.lang.String	getNodeValue(org.w3c.dom.Node node)
static java.util.List<java.lang.String>	getStringDataAsList(org.w3c.dom.Document vastDoc, java.lang.String elementName)
static java.util.List<java.lang.String>	getStringDataAsList(org.w3c.dom.Document vastDoc, java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue)
static boolean	nodeMatchesAttributeFilter(org.w3c.dom.Node node, java.lang.String attributeName, java.util.List<java.lang.String> attributeValues) Returns true iff the node has the attribute attributeName with a value that matches one of attributeValues.

Methods inherited from class java.lang.Object

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

Method Detail

getFirstMatchingChildNode

public static org.w3c.dom.Node getFirstMatchingChildNode(org.w3c.dom.Node node,
                                         java.lang.String nodeName)

Gets the first direct child of the given node with a node named nodeName. Only direct children are checked.

getFirstMatchingChildNode

public static org.w3c.dom.Node getFirstMatchingChildNode(org.w3c.dom.Node node,
                                         java.lang.String nodeName,
                                         java.lang.String attributeName,
                                         java.util.List<java.lang.String> attributeValues)

Gets the first direct child of the given node with a node named nodeName that has an attribute named attributeName with a value that matches one of attributeValues. Only direct children are checked.

Parameters:

nodeName - matching nodes must have this name.

attributeName - matching nodes must have an attribute with this name. Use null to match nodes with any attributes.

attributeValues - all matching child nodes' matching attribute will have a value that matches one of these values. Use null to match nodes with any attribute value.

getMatchingChildNodes

public static java.util.List<org.w3c.dom.Node> getMatchingChildNodes(org.w3c.dom.Node node,
                                                     java.lang.String nodeName)

Return children of the node parameter with a matching nodeName.

Parameters:

node - the root node to look beneath.

nodeName - all child nodes will match this element.

Returns:

child nodes that match the nodeName

getMatchingChildNodes

public static java.util.List<org.w3c.dom.Node> getMatchingChildNodes(org.w3c.dom.Node node,
                                                     java.lang.String nodeName,
                                                     java.lang.String attributeName,
                                                     java.util.List<java.lang.String> attributeValues)

Return children of the node parameter with a matching nodeName & attributeName that matches at least one of the passed-in attributeValues. If attributeValues is empty, no nodes will match. To match names only, pass null for both attributeName and attributeValues.

Parameters:

node - the root node to look beneath.

nodeName - all child nodes will match this element.

attributeName - all matching child nodes will have an attribute of this name.

attributeValues - all matching child nodes' matching attribute will have a value that matches one of these values.

Returns:

child nodes that match all parameters

nodeMatchesAttributeFilter

public static boolean nodeMatchesAttributeFilter(org.w3c.dom.Node node,
                                 java.lang.String attributeName,
                                 java.util.List<java.lang.String> attributeValues)

Returns true iff the node has the attribute attributeName with a value that matches one of attributeValues.

getNodeValue

public static java.lang.String getNodeValue(org.w3c.dom.Node node)

getAttributeValueAsInt

public static java.lang.Integer getAttributeValueAsInt(org.w3c.dom.Node node,
                                       java.lang.String attributeName)

getAttributeValue

public static java.lang.String getAttributeValue(org.w3c.dom.Node node,
                                 java.lang.String attributeName)

getListFromDocument

public static <T> java.util.List<T> getListFromDocument(org.w3c.dom.Document vastDoc,
                                        java.lang.String elementName,
                                        java.lang.String attributeName,
                                        java.lang.String attributeValue,
                                        XmlUtils.NodeProcessor<T> nodeProcessor)

Get a list of data from a Document]'s elements that match the {@code elementName}, {@code attributeName}, and {@code attributeValue} filters. Each node that matches these is processed by the {@code nodeProcessor} and all non-null results returned by the processor are returned.

Parameters:

vastDoc - The Document we wish to extract data from.

elementName - Only elements with this name are processed.

attributeName - Only elements with this attribute are processed.

attributeValue - Only elements whose attribute with attributeName matches this value are processed.

nodeProcessor - Takes matching nodes and produces output data for that node.

Returns:

a List<T> with processed node data.

getFirstMatchFromDocument

public static <T> T getFirstMatchFromDocument(org.w3c.dom.Document vastDoc,
                              java.lang.String elementName,
                              java.lang.String attributeName,
                              java.lang.String attributeValue,
                              XmlUtils.NodeProcessor<T> nodeProcessor)

Get first matching data from a Document]'s elements that match the {@code elementName}, {@code attributeName}, and {@code attributeValue} filters. Nodes that match are processed by the {@code nodeProcessor} until the first non-null result returned by the processor is returned.

Parameters:

vastDoc - The Document we wish to extract data from.

elementName - Only elements with this name are processed.

attributeName - Only elements with this attribute are processed.

attributeValue - Only elements whose attribute with attributeName matches this value are processed.

nodeProcessor - Takes matching nodes and produces output data for that node.

Returns:

node data of type <T> from first node that matches.

getFirstMatchingStringData

public static java.lang.String getFirstMatchingStringData(org.w3c.dom.Document vastDoc,
                                          java.lang.String elementName)

getFirstMatchingStringData

public static java.lang.String getFirstMatchingStringData(org.w3c.dom.Document vastDoc,
                                          java.lang.String elementName,
                                          java.lang.String attributeName,
                                          java.lang.String attributeValue)

getStringDataAsList

public static java.util.List<java.lang.String> getStringDataAsList(org.w3c.dom.Document vastDoc,
                                                   java.lang.String elementName)

getStringDataAsList

public static java.util.List<java.lang.String> getStringDataAsList(org.w3c.dom.Document vastDoc,
                                                   java.lang.String elementName,
                                                   java.lang.String attributeName,
                                                   java.lang.String attributeValue)

getNodesWithElementAndAttribute

public static java.util.List<org.w3c.dom.Node> getNodesWithElementAndAttribute(org.w3c.dom.Document vastDoc,
                                                               java.lang.String elementName,
                                                               java.lang.String attributeName,
                                                               java.lang.String attributeValue)