DefaultComment (dom4j 1.6.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dom4j.tree
Class DefaultComment

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

All Implemented Interfaces:: CharacterData, Cloneable, Comment, Node, Serializable

Direct Known Subclasses:: DOMComment

public class DefaultComment
extends FlyweightComment

DefaultComment is the default Comment implementation. It is a doubly linked node which supports the parent relationship and can be modified in place.

Version:: $Revision: 1.11 $
Author:: James Strachan
See Also:: Serialized Form

Field Summary

Fields inherited from class org.dom4j.tree.FlyweightComment

text

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
`DefaultComment(Element parent, String text)` DOCUMENT ME!
`DefaultComment(String text)` DOCUMENT ME!

Method Summary
`Element`	`getParent()` `getParent` returns the parent `Element` if this node supports the parent relationship or null if it is the root element or does not support the parent relationship.
`boolean`	`isReadOnly()` `isReadOnly` returns true if this node is read only and cannot be modified.
`void`	`setParent(Element parent)` `setParent` sets the parent relationship of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.
`void`	`setText(String text)` Sets the text data of this node or this method will throw an `UnsupportedOperationException` if it is read-only.
`boolean`	`supportsParent()` `supportsParent` returns true if this node supports the parent relationship.

Methods inherited from class org.dom4j.tree.FlyweightComment

createXPathResult, getText

Methods inherited from class org.dom4j.tree.AbstractComment

accept, asXML, getNodeType, getPath, getUniquePath, toString, write

Methods inherited from class org.dom4j.tree.AbstractCharacterData

appendText

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getName, getNodeTypeName, getPath, getStringValue, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, 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

accept, asXML, asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getPath, getPath, getStringValue, getUniquePath, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, valueOf, write

Constructor Detail

DefaultComment

public DefaultComment(String text)

DOCUMENT ME!
Parameters:: text - is the Comment text

DefaultComment

public DefaultComment(Element parent,
                      String text)

DOCUMENT ME!
Parameters:: parent - is the parent element; text - is the Comment text

Method Detail