Package cdc.util.data

Class AbstractChild

java.lang.Object

cdc.util.data.AbstractChild

All Implemented Interfaces:

Child, Node

Direct Known Subclasses:

AbstractContentNode, Element

public abstract class AbstractChild
extends java.lang.Object
implements Child

Base class of nodes that are children (they have a parent 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

Modifier	Constructor	Description
protected	AbstractChild()

Method Summary

Modifier and Type	Method	Description
abstract AbstractChild	clone(boolean recurse)	Return a clone of this node.
Document	getDocument()
int	getIndex()
Parent	getParent()
Child	getRootChild()	Returns the highest ancestor of this child that is a child.
Element	getRootElement()	Returns the root element of this node.
void	remove()	Detach this child from its parent.
protected void	resetParent()
void	setIndex(int to)	Set the index of this child.
void	setParent(Parent parent)	Sets or changes the parent of this child.
java.lang.String	toString()

Methods inherited from interface cdc.util.data.Child

getParent

Methods inherited from interface cdc.util.data.Node

deepEquals, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChild

protected AbstractChild()

Method Detail

clone

public abstract AbstractChild clone(boolean recurse)

Description copied from interface: Node

Return a clone of this node.

Specified by:

clone in interface Child

Specified by:

clone in interface Node

Parameters:

recurse - If true, also clone children nodes.

Returns:

A clone of this node, and optionally its children.

getRootChild

public final Child getRootChild()

Description copied from interface: Child

Returns the highest ancestor of this child that is a child.

This may be this child.

Specified by:

getRootChild in interface Child

Returns:

The root child of this child.

getDocument

public final Document getDocument()

Specified by:

getDocument in interface Node

Returns:

The document of this node, possibly null.

getRootElement

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

getParent

public final Parent getParent()

Specified by:

getParent in interface Child

Returns:

The parent of this child. It may be null.

resetParent

protected void resetParent()

setParent

public final void setParent(Parent parent)

Description copied from interface: Child

Sets or changes the parent of this child.

Specified by:

setParent in interface Child

Parameters:

parent - The new parent. May be null.

getIndex

public int getIndex()

Specified by:

getIndex in interface Child

Returns:

The index of this child or -1.

setIndex

public void setIndex(int to)

Description copied from interface: Child

Set the index of this child.

Specified by:

setIndex in interface Child

Parameters:

to - The new index of this child.

remove

public final void remove()

Description copied from interface: Child

Detach this child from its parent.

Equivalent to setParent(null).

Specified by:

remove in interface Child

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object