com.screenscraper.common

Class XmlNode

java.lang.Object

com.screenscraper.common.XmlNode

public class XmlNode
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
XmlNode(org.w3c.dom.NodeList nodeList) Constructs a new one based on a NodeList.
XmlNode(java.lang.String value) Constructs a new node with the given value.
XmlNode(java.lang.String name, org.w3c.dom.NamedNodeMap attributes) Constructs a new node with the given name and attributes.

Method Summary

Modifier and Type	Method and Description
protected void	addAttribute(java.lang.String key, java.lang.String value) Adds a new attribute.
protected void	addChildNode(XmlNode childNode) Adds a child node.
void	dumpToLog() Dumps the contents of the node and all of its child nodes to the internal logger.
java.util.ArrayList<KeyValue>	getAttributes() Gets a list of all attributes for the node.
java.util.ArrayList<XmlNode>	getChildNodes() Gets a list of child nodes.
java.lang.String	getName() Gets the name of the node.
java.lang.String	getValue() Gets the value of the node.
protected void	setName(java.lang.String name) Sets the name of the node.
protected void	setValue(java.lang.String value) Sets the value of the node.
java.lang.String	toXmlString() Converts the node to an XML string

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

XmlNode

public XmlNode(@Nullable
               org.w3c.dom.NodeList nodeList)

Constructs a new one based on a NodeList.

XmlNode

public XmlNode(java.lang.String name,
               @Nullable
               org.w3c.dom.NamedNodeMap attributes)

Constructs a new node with the given name and attributes.

Parameters:

name - The name of the node.

attributes - The attributes of the node.

XmlNode

public XmlNode(java.lang.String value)

Constructs a new node with the given value.

Parameters:

value - The value of the node.

Method Detail

getName

@Nullable
public java.lang.String getName()

Gets the name of the node.

Returns:

The name of the node (e.g., for a tag the name would be td).

setName

protected void setName(java.lang.String name)

Sets the name of the node.

Parameters:

name - The name of the node (e.g., for a tag the name would be td).

getValue

@Nullable
public java.lang.String getValue()

Gets the value of the node.

Returns:

The value of the node.

setValue

protected void setValue(java.lang.String value)

Sets the value of the node.

Parameters:

value - The value of the node.

getChildNodes

@Nullable
public java.util.ArrayList<XmlNode> getChildNodes()

Gets a list of child nodes.

Returns:

An ArrayList of XmlNode objects.

addChildNode

protected void addChildNode(XmlNode childNode)

Adds a child node.

Parameters:

childNode - An XmlNode.

getAttributes

@Nullable
public java.util.ArrayList<KeyValue> getAttributes()

Gets a list of all attributes for the node.

Returns:

An ArrayList of KeyValue objects.

addAttribute

protected void addAttribute(java.lang.String key,
                            java.lang.String value)

Adds a new attribute.

Parameters:

key - The key portion.

value - The value portion.

dumpToLog

public void dumpToLog()

Dumps the contents of the node and all of its child nodes to the internal logger.

toXmlString

@NotNull
public java.lang.String toXmlString()

Converts the node to an XML string

Returns:

The XML String that the node represents