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

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	addChild(Child child)	Add a child to this parent, if possible.
boolean	canAddChild(Child child)	Returns true when a child can be added.
void	clearChildren()	Removes all children.
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	ensureChildren()
java.util.List<AbstractChild>	getChildren()
Document	getDocument()
Element	getRootElement()
NodeType	getType()
boolean	removeChild(Child child)	Remove a child.
AbstractChild	removeChildAt(int index)	Remove the child located at a given index.
boolean	supportsChildType(NodeType type)	Returns true when this node supports a child of a given type.

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

getChildAt, getChildren, getChildren, getChildrenCount, getChildrenCount, getLastChild, hasChildren

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()

Specified by:

getRootElement in interface Node

Returns:

The root element of this node, possibly null.

supportsChildType

public boolean supportsChildType(NodeType type)

Description copied from interface: Parent

Returns true when this node supports a child of a given type.

Specified by:

supportsChildType in interface Parent

Parameters:

type - The type.

Returns:

true when type is supported for a child.

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 an be added.

ensureChildren

public void ensureChildren()

Specified by:

ensureChildren in interface Parent

getChildren

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

Specified by:

getChildren in interface Parent

Returns:

A list of children.

addChild

public boolean addChild(Child child)

Description copied from interface: Parent

Add a child to this parent, if possible.

If possible, child current parent is changed to this node.

Specified by:

addChild in interface Parent

Parameters:

child - The child.

Returns:

True when the child was added, false otherwise.

removeChild

public boolean removeChild(Child child)

Description copied from interface: Parent

Remove a child.

If child is not a child of this parent, then false is returned.

Specified by:

removeChild in interface Parent

Parameters:

child - The child.

Returns:

true if child was removed, false otherwise.

removeChildAt

public AbstractChild removeChildAt(int index)

Description copied from interface: Parent

Remove the child located at a given index.

If index is invalid, returns false.

Specified by:

removeChildAt in interface Parent

Parameters:

index - The index.

Returns:

true when removal was a success, false otherwise.

clearChildren

public void clearChildren()

Description copied from interface: Parent

Removes all children.

Specified by:

clearChildren in interface Parent