org.mdiutil.xml.tree

Class XMLRoot

java.lang.Object

org.mdiutil.xml.tree.XMLNode

org.mdiutil.xml.tree.XMLRoot

All Implemented Interfaces:

Iterable<XMLNode>, CommentedNode, NumberedNode

Direct Known Subclasses:

XMLCommentedRoot, XMLInvalidRoot, XMLNumberedRoot

public class XMLRoot
extends XMLNode

A root Node in an XML File.

Nested Class Summary

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

XMLNode.BoundPrefix

Field Summary

Fields

Modifier and Type	Field and Description
protected String	encoding The XML encoding.

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

attributes, boundPrefixes, cData, children, nodeParent, qname

Constructor Summary

Constructors

Constructor and Description
XMLRoot(QName qName) Create the root Node.
XMLRoot(String nodeName) Create the root Node, with a local part.

Method Summary

Modifier and Type	Method and Description
XMLRoot	copy() Create a copy of this node.
XMLRoot	copy(boolean deep) Create a copy of this node.
XMLCommentedRoot	copyAsCommentedNode() Create a copy of this node as a commented root.
boolean	equals(Object obj)
String	getEncoding() Return the declared encoding of the XML file.
int	hashCode()
void	setEncoding(String encoding) Set the encoding of 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, 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

getLineNumber, hasLineNumber, setLineNumber

Field Detail

encoding

protected String encoding

The XML encoding.

Constructor Detail

XMLRoot

public XMLRoot(String nodeName)

Create the root Node, with a local part.

Parameters:

nodeName - the Node name

See Also:

XMLNode.XMLNode(java.lang.String)

XMLRoot

public XMLRoot(QName qName)

Create the root Node.

Parameters:

qName - the Node qualified name

Method Detail

setEncoding

public void setEncoding(String encoding)

Set the encoding of the XML file.

Parameters:

encoding - the encoding of the XML file

getEncoding

public String getEncoding()

Return the declared encoding of the XML file. Return null if there is no declared encoding in the file.

Returns:

the declared encoding of the XML file

copyAsCommentedNode

public XMLCommentedRoot copyAsCommentedNode()

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

Overrides:

copyAsCommentedNode in class XMLNode

Returns:

the Node copy.

copy

public XMLRoot 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 XMLRoot 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 XMLNode

Parameters:

deep - true for a deep copy

Returns:

the Node copy.

hashCode

public int hashCode()

Overrides:

hashCode in class XMLNode

equals

public boolean equals(Object obj)

Overrides:

equals in class XMLNode