com.uc4.api.objects

Class XMLDocuNode

java.lang.Object

com.uc4.api.objects.XMLDocuNode

All Implemented Interfaces:

Iterable<XMLDocuNode>

public class XMLDocuNode
extends Object
implements Iterable<XMLDocuNode>

This class represents one node in the structured documentation.

Constructor Summary

Constructors

Constructor and Description
XMLDocuNode(String name) Creates a new XMLDocuNode with the specified name.

Method Summary

Modifier and Type	Method and Description
void	addChildNode(XMLDocuNode node) Adds a new child node.
String	getAttribute(String attributeName)
Map<String,String>	getAttributes() Returns a Map of all attribute names and values which are defined for this element.
int	getChildCount() Returns the number of Child elements.
String	getNodeName() Returns the name of this node.
String	getValue() Returns the value of this node or an empty String if not set.
boolean	hasChildNodes()
Iterator<XMLDocuNode>	iterator() Iterator which returns all child nodes.
void	removeAttribute(String name, String value) Removes Attribute from node.
void	removeChildNodes() Removes all child nodes.
void	setAttribute(String name, String value) Sets the value of an attribute.
void	setValue(String value) Sets the value of this node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XMLDocuNode

public XMLDocuNode(String name)

Creates a new XMLDocuNode with the specified name.

Parameters:

name - Name of the node in the tree

Method Detail

getAttribute

public String getAttribute(String attributeName)

Parameters:

attributeName - Name of the attribute

Returns:

Returns the value of the specified attribtue or an empty String if the attribute was not found

getAttributes

public Map<String,String> getAttributes()

Returns a Map of all attribute names and values which are defined for this element.

Returns:

Map of attributes

setAttribute

public void setAttribute(String name,
                         String value)

Sets the value of an attribute.

Parameters:

name - Name

value - Value

removeAttribute

public void removeAttribute(String name,
                            String value)

Removes Attribute from node.

Parameters:

name - Attribute Name

value - Attribute Value

getChildCount

public int getChildCount()

Returns the number of Child elements.

Returns:

Count

setValue

public void setValue(String value)

Sets the value of this node.

Parameters:

value - Node value

getNodeName

public String getNodeName()

Returns the name of this node.

Returns:

Node Name

getValue

public String getValue()

Returns the value of this node or an empty String if not set.

Returns:

Value

addChildNode

public void addChildNode(XMLDocuNode node)

Adds a new child node.

Parameters:

node - Child Node

hasChildNodes

public boolean hasChildNodes()

Returns:

true if this node has child nodes

removeChildNodes

public void removeChildNodes()

Removes all child nodes.

iterator

public Iterator<XMLDocuNode> iterator()

Iterator which returns all child nodes.

Specified by:

iterator in interface Iterable<XMLDocuNode>

Returns:

Child nodes