org.dom4j.tree
Class AbstractComment

java.lang.Object
  org.dom4j.tree.AbstractNode
      org.dom4j.tree.AbstractCharacterData
          org.dom4j.tree.AbstractComment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CharacterData, Comment, Node

Direct Known Subclasses:

FlyweightComment

public abstract class AbstractComment
extends AbstractCharacterData
implements Comment

AbstractComment is an abstract base class for tree implementors to use for implementation inheritence.

Version:

$Revision: 1.13 $

Author:

James Strachan

See Also:

Serialized Form

Constructor Summary

AbstractComment()

Method Summary

void	accept(Visitor visitor) accept is the method used in the Visitor Pattern.
java.lang.String	asXML() asXML returns the textual XML representation of this node.
NodeType	getNodeTypeEnum() Returns the type of this node as constant from NodeType enum.
java.lang.String	getPath(Element context) Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.
java.lang.String	getUniquePath(Element context) Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node.
protected void	toString(java.lang.StringBuilder builder)
void	write(java.io.Writer writer) write writes this node as the default XML notation for this node.

Methods inherited from class org.dom4j.tree.AbstractCharacterData

appendText

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, clone, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getDocument, getDocumentFactory, getName, getNodeType, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, toString, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dom4j.CharacterData

appendText

Methods inherited from interface org.dom4j.Node

asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf

Constructor Detail

AbstractComment

public AbstractComment()

Method Detail

getNodeTypeEnum

public NodeType getNodeTypeEnum()

Description copied from interface: Node

Returns the type of this node as constant from NodeType enum.

Specified by:

getNodeTypeEnum in interface Node

Overrides:

getNodeTypeEnum in class AbstractNode

Returns:

the type of this node

getPath

public java.lang.String getPath(Element context)

Description copied from interface: Node

Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. No indexing will be used to restrict the path if multiple elements with the same name occur on the path.

Specified by:

getPath in interface Node

Overrides:

getPath in class AbstractCharacterData

Parameters:

context - is the parent context from which the relative path should start. If the context is null or the context is not an ancestor of this node then the path will be absolute and start from the document and so begin with the '/' character.

Returns:

the XPath expression relative to the given context which will return a nodeset containing at least this node.

getUniquePath

public java.lang.String getUniquePath(Element context)

Description copied from interface: Node

Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. This method will use the XPath index operator to restrict the path if multiple elements with the same name occur on the path.

Specified by:

getUniquePath in interface Node

Overrides:

getUniquePath in class AbstractCharacterData

Parameters:

context - is the parent context from which the path should start. If the context is null or the context is not an ancestor of this node then the path will start from the document and so begin with the '/' character.

Returns:

the XPath expression relative to the given context which will return a nodeset containing just this node.

toString

protected void toString(java.lang.StringBuilder builder)

Overrides:

toString in class AbstractNode

asXML

public java.lang.String asXML()

Description copied from interface: Node

asXML returns the textual XML representation of this node.

Specified by:

asXML in interface Node

Returns:

the XML representation of this node

write

public void write(java.io.Writer writer)
           throws java.io.IOException

Description copied from interface: Node

write writes this node as the default XML notation for this node. If you wish to control the XML output (such as for pretty printing, changing the indentation policy etc.) then please use XMLWriter or its derivations.

Specified by:

write in interface Node

Overrides:

write in class AbstractNode

Parameters:

writer - is the Writer to output the XML to

Throws:

java.io.IOException - DOCUMENT ME!

accept

public void accept(Visitor visitor)

Description copied from interface: Node

accept is the method used in the Visitor Pattern.

Specified by:

accept in interface Node

Parameters:

visitor - is the visitor in the Visitor Pattern