org.mdiutil.xml.tree

Class XMLCommentedNode

java.lang.Object

org.mdiutil.xml.tree.XMLNode

org.mdiutil.xml.tree.XMLCommentedNode

All Implemented Interfaces:

Iterable<XMLNode>, CommentedNode, NumberedNode

public class XMLCommentedNode
extends XMLNode
implements CommentedNode, NumberedNode

A Node in an XML File, with an associated comment.

Nested Class Summary

Nested classes/interfaces inherited from class org.mdiutil.xml.tree.XMLNode

XMLNode.BoundPrefix

Field Summary

Fields inherited from class org.mdiutil.xml.tree.XMLNode

attributes, boundPrefixes, cData, children, nodeParent, qname

Constructor Summary

Constructors

Constructor and Description
XMLCommentedNode(QName qname) Create the Node.
XMLCommentedNode(QName qname, String comment) Create the Node.
XMLCommentedNode(String nodeName) Create the Node, with a local part.
XMLCommentedNode(String nodeName, String comment) Create the Node, with a local part and a comment.
XMLCommentedNode(XMLNode parent, QName qname) Create a Node.
XMLCommentedNode(XMLNode parent, QName qname, String comment) Create a Node.
XMLCommentedNode(XMLNode parent, String nodeName) Create a Node.
XMLCommentedNode(XMLNode parent, String nodeName, String comment) Create a Node.

Method Summary

Modifier and Type	Method and Description
XMLCommentedNode	copy() Create a copy of this node.
XMLCommentedNode	copy(boolean deep) Create a copy of this node.
String	getComment() Return the node comment.
int	getLineNumber() Return the line number of the Node in the XML file.
boolean	hasComment() Return true if the node has a comment.
boolean	hasLineNumber() Return true if the Node has an associated line number.
void	setComment(String comment) Set the node comment.
void	setLineNumber(int lineNumber) Set the line number of the Node in the XML file.

Methods inherited from class org.mdiutil.xml.tree.XMLNode

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChild, attributeValueIsBoolean, attributeValueIsBoolean, attributeValueIsByte, attributeValueIsByte, attributeValueIsChar, attributeValueIsChar, attributeValueIsDouble, attributeValueIsDouble, attributeValueIsFloat, attributeValueIsFloat, attributeValueIsInt, attributeValueIsInt, attributeValueIsInt, attributeValueIsLong, attributeValueIsLong, attributeValueIsLong, attributeValueIsLong, attributeValueIsShort, attributeValueIsShort, bindPrefix, CDATAValueIsBoolean, CDATAValueIsByte, CDATAValueIsChar, CDATAValueIsDouble, CDATAValueIsFloat, CDATAValueIsInt, CDATAValueIsInt, CDATAValueIsLong, CDATAValueIsLong, CDATAValueIsShort, copyAsCommentedNode, countAttributes, countChildren, equals, getAllChildren, getAllChildren, getAttributes, getAttributeValue, getAttributeValue, getAttributeValueAsBoolean, getAttributeValueAsBoolean, getAttributeValueAsBoolean, getAttributeValueAsByte, getAttributeValueAsByte, getAttributeValueAsByte, getAttributeValueAsChar, getAttributeValueAsChar, getAttributeValueAsChar, getAttributeValueAsDouble, getAttributeValueAsDouble, getAttributeValueAsDouble, getAttributeValueAsFloat, getAttributeValueAsFloat, getAttributeValueAsFloat, getAttributeValueAsInt, getAttributeValueAsInt, getAttributeValueAsInt, getAttributeValueAsInt, getAttributeValueAsLong, getAttributeValueAsLong, getAttributeValueAsLong, getAttributeValueAsLong, getAttributeValueAsShort, getAttributeValueAsShort, getAttributeValueAsShort, getBoundedPrefix, getBoundPrefixes, getCDATA, getCDATAValueAsBoolean, getCDATAValueAsByte, getCDATAValueAsChar, getCDATAValueAsDouble, getCDATAValueAsFloat, getCDATAValueAsInt, getCDATAValueAsInt, getCDATAValueAsLong, getCDATAValueAsLong, getCDATAValueAsShort, getCDATAValueAsString, getChild, getChildren, getCompleteName, getEscapedCDATA, getFirstChild, getIndex, getIndexInParent, getLastChild, getLocalPart, getName, getNamespaceURI, getNextSibling, getNodePath, getParent, getPrefix, getPrefixedName, getPreviousSibling, getQualifiedName, getSchemaLocationDeclaration, getSchemaLocationValue, hasAttribute, hasAttribute, hasBoundPrefix, hasBoundPrefixes, hasCDATA, hasChildren, hashCode, hasParent, hasSchemaLocationDeclaration, isWellFormed, iterator, search, search, search, search, searchFirst, searchFirst, searchFirst, searchFirst, searchFirstForNames, searchFirstForNames, searchForNames, searchForNames, setBoundPrefixes, setCDATA, setParent, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XMLCommentedNode

public XMLCommentedNode(String nodeName)

Create the Node, with a local part.

Parameters:

nodeName - the Node name

XMLCommentedNode

public XMLCommentedNode(String nodeName,
                        String comment)

Create the Node, with a local part and a comment.

Parameters:

nodeName - the Node name

comment - the comment

XMLCommentedNode

public XMLCommentedNode(QName qname)

Create the Node.

Parameters:

qname - the Node qualified name

XMLCommentedNode

public XMLCommentedNode(QName qname,
                        String comment)

Create the Node.

Parameters:

qname - the Node qualified name

comment - the comment

XMLCommentedNode

public XMLCommentedNode(XMLNode parent,
                        String nodeName)

Create a Node.

Parameters:

parent - the Node parent

nodeName - the Node name

XMLCommentedNode

public XMLCommentedNode(XMLNode parent,
                        String nodeName,
                        String comment)

Create a Node.

Parameters:

parent - the Node parent

nodeName - the Node name

comment - the comment

XMLCommentedNode

public XMLCommentedNode(XMLNode parent,
                        QName qname)

Create a Node.

Parameters:

parent - the Node parent

qname - the Node qualified name

XMLCommentedNode

public XMLCommentedNode(XMLNode parent,
                        QName qname,
                        String comment)

Create a Node.

Parameters:

parent - the Node parent

qname - the Node qualified name

comment - the comment

Method Detail

setComment

public void setComment(String comment)

Set the node comment.

Specified by:

setComment in interface CommentedNode

Parameters:

comment - the comment

getComment

public String getComment()

Return the node comment.

Specified by:

getComment in interface CommentedNode

Returns:

the node comment

hasComment

public boolean hasComment()

Return true if the node has a comment.

Specified by:

hasComment in interface CommentedNode

Returns:

true if the node has a comment

setLineNumber

public void setLineNumber(int lineNumber)

Set the line number of the Node in the XML file. Do ntohing by default.

Specified by:

setLineNumber in interface NumberedNode

Parameters:

lineNumber - the line number

getLineNumber

public int getLineNumber()

Return the line number of the Node in the XML file.

Specified by:

getLineNumber in interface NumberedNode

Returns:

the line number

hasLineNumber

public boolean hasLineNumber()

Return true if the Node has an associated line number.

Specified by:

hasLineNumber in interface NumberedNode

Returns:

true if the Node has an associated line number

copy

public XMLCommentedNode copy()

Create a copy of this node. It will also copy all the children under this node.

Overrides:

copy in class XMLNode

Returns:

the Node copy.

copy

public XMLCommentedNode copy(boolean deep)

Create a copy of this node. It will also copy all the children under this node.

Overrides:

copy in class XMLNode

Parameters:

deep - true for a deep copy

Returns:

the Node copy.