Package org.dom4j.tree
Class AbstractComment
java.lang.Object
org.dom4j.tree.AbstractNode
org.dom4j.tree.AbstractCharacterData
org.dom4j.tree.AbstractComment
- All Implemented Interfaces:
Serializable
,Cloneable
,CharacterData
,Comment
,Node
- Direct Known Subclasses:
FlyweightComment
AbstractComment
is an abstract base class for tree
implementors to use for implementation inheritence.
- Version:
- $Revision: 1.13 $
- Author:
- James Strachan
- See Also:
-
Field Summary
Fields inherited from class org.dom4j.tree.AbstractNode
NODE_TYPE_NAMES
Fields inherited from interface org.dom4j.Node
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
is the method used in the Visitor Pattern.asXML()
asXML
returns the textual XML representation of this node.short
Returns the code according to the type of node.Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.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.toString()
void
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, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, 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, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf
-
Constructor Details
-
AbstractComment
public AbstractComment()
-
-
Method Details
-
getNodeType
public short getNodeType()Description copied from interface:Node
Returns the code according to the type of node. This makes processing nodes polymorphically much easier as the switch statement can be used instead of multiple if (instanceof) statements.- Specified by:
getNodeType
in interfaceNode
- Overrides:
getNodeType
in classAbstractNode
- Returns:
- a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE
-
getPath
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 interfaceNode
- Overrides:
getPath
in classAbstractCharacterData
- 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
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 interfaceNode
- Overrides:
getUniquePath
in classAbstractCharacterData
- 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
-
asXML
Description copied from interface:Node
asXML
returns the textual XML representation of this node. -
write
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 useXMLWriter
or its derivations.- Specified by:
write
in interfaceNode
- Overrides:
write
in classAbstractNode
- Parameters:
writer
- is theWriter
to output the XML to- Throws:
IOException
- DOCUMENT ME!
-
accept
Description copied from interface:Node
accept
is the method used in the Visitor Pattern.
-