Package cdc.util.data

Class Comment

java.lang.Object

cdc.util.data.AbstractChild

cdc.util.data.AbstractContentNode

cdc.util.data.Comment

All Implemented Interfaces:

Child, Leaf, Node

public final class Comment
extends AbstractContentNode

Comment node.

It has a text content and can be attached to a Document or Element.

Author:

Damien Carbonne

Field Summary

Fields inherited from interface cdc.util.data.Node

ANY_NODE, ELEMENT_NAME_AND_ATTRIBUTES_COMPARATOR, ELEMENT_NAME_COMPARATOR, IS_COMMENT, IS_ELEMENT, IS_IGNORABLE_TEXT, IS_PURE_ELEMENT, IS_TEXT

Constructor Summary

Constructors

Constructor	Description
Comment()
Comment(Comment other)
Comment(Parent parent)
Comment(Parent parent, String content)
Comment(String content)

Method Summary

Modifier and Type	Method	Description
Comment	appendContent(char[] str, int offset, int len)
Comment	appendContent(CharSequence cs, int start, int end)
Comment	appendContent(String content)
Comment	clearContent()
Comment	clone(boolean recurse)	Return a clone of this node.
String	getQName()
NodeType	getType()
Comment	setContent(String content)
Comment	setIndex(int to)	Set the index of this child.
Comment	setParent(Parent parent)	Sets or changes the parent of this child.

Methods inherited from class cdc.util.data.AbstractContentNode

deepEquals, getContent

Methods inherited from class cdc.util.data.AbstractChild

equals, getDocument, getParent, getRootElement, hashCode, resetParent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cdc.util.data.Child

detach, getIndex, getParent, getParent, getRootChild

Methods inherited from interface cdc.util.data.Node

getDocument, getRootElement

Constructor Detail

Comment

public Comment(Parent parent,
               String content)

Comment

public Comment()

Comment

public Comment(Parent parent)

Comment

public Comment(String content)

Comment

public Comment(Comment other)

Method Detail

getType

public NodeType getType()

Returns:

The node type.

clone

public Comment 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

Specified by:

clone in class AbstractChild

Parameters:

recurse - If true, also clone children nodes.

Returns:

A clone of this node, and optionally its children.

getQName

public String getQName()

Returns:

A string representation of this node. May be used for debug.

setParent

public Comment setParent(Parent parent)

Description copied from interface: Child

Sets or changes the parent of this child.

Specified by:

setParent in interface Child

Overrides:

setParent in class AbstractChild

Parameters:

parent - The new parent. May be null.

Returns:

This object.

setIndex

public Comment setIndex(int to)

Description copied from interface: Child

Set the index of this child.

Parameters:

to - The new index of this child.

Returns:

This object.

setContent

public Comment setContent(String content)

Overrides:

setContent in class AbstractContentNode

clearContent

public Comment clearContent()

Overrides:

clearContent in class AbstractContentNode

appendContent

public Comment appendContent(String content)

Overrides:

appendContent in class AbstractContentNode

appendContent

public Comment appendContent(CharSequence cs,
                             int start,
                             int end)

Overrides:

appendContent in class AbstractContentNode

appendContent

public Comment appendContent(char[] str,
                             int offset,
                             int len)

Overrides:

appendContent in class AbstractContentNode