org.mdiutil.xml.tree

Class XMLNumberedRoot

java.lang.Object

org.mdiutil.xml.tree.XMLNode

org.mdiutil.xml.tree.XMLRoot

org.mdiutil.xml.tree.XMLNumberedRoot

All Implemented Interfaces:

Iterable<XMLNode>, CommentedNode, NumberedNode

public class XMLNumberedRoot
extends XMLRoot

A root Node in an XML File with a 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, boundPrefixes, cData, children, nodeParent, qname

Constructor Summary

Constructors

Constructor and Description
XMLNumberedRoot(QName qname) Create the Node.
XMLNumberedRoot(QName qname, int lineNumber) Create the Node.
XMLNumberedRoot(String nodeName) Create the root Node, with a local part.
XMLNumberedRoot(String nodeName, int lineNumber) Create the root Node.

Method Summary

Modifier and Type	Method and Description
XMLNumberedRoot	copy() Create a copy of this node.
XMLNumberedRoot	copy(boolean deep) Create a copy of this node.
int	getLineNumber() Return the line number of the Node in the XML file.
boolean	hasLineNumber() Return true if the Node has an associated line number.

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

copyAsCommentedNode, equals, getEncoding, hashCode, setEncoding

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, 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, 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, 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

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

getComment, hasComment, setComment

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

setLineNumber

Constructor Detail

XMLNumberedRoot

public XMLNumberedRoot(String nodeName)

Create the root Node, with a local part.

Parameters:

nodeName - the Node name

See Also:

XMLNode.XMLNode(java.lang.String)

XMLNumberedRoot

public XMLNumberedRoot(QName qname)

Create the Node.

Parameters:

qname - the Node qualified name

XMLNumberedRoot

public XMLNumberedRoot(String nodeName,
                       int lineNumber)

Create the root Node.

Parameters:

nodeName - the Node name

lineNumber - the line number of the Node in the XML file

XMLNumberedRoot

public XMLNumberedRoot(QName qname,
                       int lineNumber)

Create the Node.

Parameters:

qname - the Node qualified name

lineNumber - the line number of the Node in the XML file

Method Detail

getLineNumber

public int getLineNumber()

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

Returns:

the line number

hasLineNumber

public boolean hasLineNumber()

Return true if the Node has an associated line number.

Returns:

true if the Node has an associated line number

copy

public XMLNumberedRoot 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 XMLNumberedRoot 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.