org.mdiutil.xml.tree

Class XMLCommentedRoot

java.lang.Object

org.mdiutil.xml.tree.XMLNode

org.mdiutil.xml.tree.XMLRoot

org.mdiutil.xml.tree.XMLCommentedRoot

All Implemented Interfaces:

Iterable<XMLNode>, CommentedNode, NumberedNode

public class XMLCommentedRoot
extends XMLRoot
implements CommentedNode

A root 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.XMLRoot

encoding

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

attributes, attributesOrder, boundPrefixes, boundURIs, cData, children, nodeParent, qname, SCHEMA_INSTANCE, SCHEMA_URI

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
XMLCommentedRoot	copy() Create a copy of this node.
XMLCommentedRoot	copy(boolean deep) Create a copy of this node.
String	getComment() Return the node comment.
boolean	hasComment() Return true if the node has a comment.
void	setComment(String comment) Set the node comment.

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

copyAsCommentedNode, equals, getEncoding, getURI, hashCode, setEncoding, setURI

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, addChild, addChild, attributesIterator, 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, countAttributes, countChildren, 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, getAttributeValueAsQName, getAttributeValueAsQName, getAttributeValueAsShort, getAttributeValueAsShort, getAttributeValueAsShort, getBoundedURI, getBoundPrefix, getBoundPrefixes, getBoundURIs, getCDATA, getCDATAValueAsBoolean, getCDATAValueAsByte, getCDATAValueAsChar, getCDATAValueAsDouble, getCDATAValueAsFloat, getCDATAValueAsInt, getCDATAValueAsInt, getCDATAValueAsLong, getCDATAValueAsLong, getCDATAValueAsShort, getCDATAValueAsString, getChild, getChildren, getCompleteName, getEscapedCDATA, getFirstChild, getIndex, getIndexInParent, getIndirectBoundedURI, getIndirectBoundPrefix, getLastChild, getLocalPart, getName, getNamespaceURI, getNextSibling, getNodeLevel, getNodePath, getParent, getPrefix, getPrefixedName, getPreviousSibling, getQualifiedName, getSchemaLocationDeclaration, getSchemaLocationValue, hasAttribute, hasAttribute, hasAttribute, hasAttributes, hasBoundPrefix, hasBoundPrefixes, hasBoundURI, hasBoundURIs, hasCDATA, hasChildren, hasIndirectBoundPrefix, hasIndirectBoundURI, hasParent, hasSchemaLocationDeclaration, isWellFormed, iterator, orderedAttributesIterator, removeAttribute, removeAttribute, 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

Methods inherited from interface org.mdiutil.xml.tree.NumberedNode

getLineNumber, hasLineNumber, setLineNumber

Constructor Detail

XMLCommentedRoot

public XMLCommentedRoot(String nodeName)

Create the Node, with a local part.

Parameters:

nodeName - the Node name

XMLCommentedRoot

public XMLCommentedRoot(String nodeName,
                        String comment)

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

Parameters:

nodeName - the Node name

comment - the comment

XMLCommentedRoot

public XMLCommentedRoot(QName qname)

Create the Node.

Parameters:

qname - the Node qualified name

XMLCommentedRoot

public XMLCommentedRoot(QName qname,
                        String comment)

Create the Node.

Parameters:

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

copy

public XMLCommentedRoot copy()

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

Overrides:

copy in class XMLRoot

Returns:

the Node copy.

copy

public XMLCommentedRoot copy(boolean deep)

Create a copy of this node. It deep is true, then will also copy all the children under this node.

Overrides:

copy in class XMLRoot

Parameters:

deep - true for a deep copy

Returns:

the Node copy.