Package cdc.util.data

Class Document

java.lang.Object

cdc.util.data.Document

All Implemented Interfaces:

Node, Parent

public final class Document
extends java.lang.Object
implements Parent

XML like Document node.

Author:

Damien Carbonne

Field Summary

Fields inherited from interface cdc.util.data.Node

ANY_NODE, IS_COMMENT, IS_ELEMENT, IS_EMPTY_ELEMENT, IS_IGNORABLE_TEXT, IS_TEXT

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
boolean	canAddChild(Child child)	Returns true when a child can be added.
Document	clone(boolean recurse)	Return a clone of this node.
boolean	deepEquals(Node node)	Return true when this node and its descendants equals other node hierarchy.
void	doAddChild(Child child)	Implementation.
void	doRemoveChild(Child child)	Implementation.
java.util.List<AbstractChild>	getChildren()
Document	getDocument()
Element	getRootElement()	Returns the root element of this node.
static Element	getRootElement(Document document)	Returns the root element of a document.
NodeType	getType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdc.util.data.Parent

addChild, addChildren, addChildren, addElement, changeComments, changeComments, changeNamedTexts, changeNamedTexts, changeTexts, changeTexts, getChild, getChild, getChildAt, getChildAt, getChildAt, getChildren, getChildren, getChildrenCount, getChildrenCount, getChildrenCount, getComments, getElementNamed, getElementNamedAt, getElementNamedIgnoreCase, getElementNamedIgnoreCaseAt, getElementNamedWithAttribute, getElements, getElementsNamed, getElementsNamedIgnoreCase, getLastChild, getTexts, hasChildren, hasChildren, hasChildren, hasComments, hasElements, hasTexts, mergeComments, mergeComments, mergeTexts, mergeTexts, removeChild, removeChildAt, removeChildren, removeChildren, removeChildren, removeComments, removeComments, removeElementsNamed, removeElementsNamed, removeIgnorableTexts, removeIgnorableTexts, removeTexts, removeTexts, sortChildren, sortChildren

Constructor Detail

Document

public Document()

Method Detail

getType

public NodeType getType()

Specified by:

getType in interface Node

Returns:

The node type.

clone

public Document clone(boolean recurse)

Description copied from interface: Node

Return a clone of this node.

Specified by:

clone in interface Node

Specified by:

clone in interface Parent

Parameters:

recurse - If true, also clone children nodes.

Returns:

A clone of this node, and optionally its children.

deepEquals

public boolean deepEquals(Node node)

Description copied from interface: Node

Return true when this node and its descendants equals other node hierarchy.

Parents are ignored.

Specified by:

deepEquals in interface Node

Parameters:

node - The other node to compare.

Returns:

True when this node and other node have same hierarchies.

getDocument

public Document getDocument()

Specified by:

getDocument in interface Node

Returns:

The document of this node, possibly null.

getRootElement

public Element getRootElement()

Description copied from interface: Node

Returns the root element of this node.

If this node is a document, then this is its unique child element, possibly null.
If this node is a child, then this is the highest ancestor that is an element, possibly null.

Specified by:

getRootElement in interface Node

Returns:

The root element of this node, possibly null.

getRootElement

public static Element getRootElement(Document document)

Returns the root element of a document.

If document is null, then null is returned.

Parameters:

document - The document (possibly null).

Returns:

The root element of document.

canAddChild

public boolean canAddChild(Child child)

Description copied from interface: Parent

Returns true when a child can be added.

Specified by:

canAddChild in interface Parent

Parameters:

child - The child

Returns:

true when child can be added.

doAddChild

public void doAddChild(Child child)

Description copied from interface: Parent

Implementation.

WARNING: Do not use, this is an implementation detail that may change at any time.

Specified by:

doAddChild in interface Parent

Parameters:

child - The child to add.

doRemoveChild

public void doRemoveChild(Child child)

Description copied from interface: Parent

Implementation.

WARNING: Do not use, this is an implementation detail that may change at any time.

Specified by:

doRemoveChild in interface Parent

Parameters:

child - The child to remove.

getChildren

public java.util.List<AbstractChild> getChildren()

Specified by:

getChildren in interface Parent

Returns:

A list of children.