| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.dom4j.tree.AbstractNode
org.dom4j.tree.AbstractBranch
org.dom4j.tree.AbstractElement
org.dom4j.tree.DefaultElement
org.dom4j.util.UserDataElement
 UserDataElement support the adornment of a user data object on
 an Element or Attribute instance such that the methods 
 setData(Object)will get and set the values of a user data object.
 This can be useful for developers wishing to create XML trees and adorn the
 trees with user defined objects.
 
| Field Summary | 
| Fields inherited from class org.dom4j.tree.AbstractElement | 
| EMPTY_ITERATOR, EMPTY_LIST, USE_STRINGVALUE_SEPARATOR, VERBOSE_TOSTRING | 
| Fields inherited from class org.dom4j.tree.AbstractBranch | 
| DEFAULT_CONTENT_LIST_SIZE | 
| 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 | |
| UserDataElement(QName qname) | |
| UserDataElement(String name) | |
| Method Summary | |
|  Object | clone()clonewill return a deep clone or if this node is
 read-only then clone will return the same instance. | 
| protected  Element | createElement(QName qName) | 
| protected  Element | createElement(String name) | 
| protected  Object | getCopyOfUserData()If a deep copy of user data is required whenever the clone() or createCopy() methods are called on this element then this method should return a clone of the user data | 
|  Object | getData()Accesses the data of this element which may implement data typing bindings such as XML Schema or Java Bean bindings or will return the same value as DefaultElement.getText() | 
|  void | setData(Object data)Sets the data value of this element if this element supports data binding or calls AbstractElement.setText(java.lang.String)if it doesn't | 
|  String | toString() | 
| Methods inherited from class org.dom4j.tree.AbstractBranch | 
| addElement, addElement, addElement, appendContent, content, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getTextTrim, hasContent, invalidNodeTypeAddException, isReadOnly, setProcessingInstructions | 
| Methods inherited from class org.dom4j.tree.AbstractNode | 
| asXPathResult, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf | 
| Methods inherited from class java.lang.Object | 
| equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Methods inherited from interface org.dom4j.Element | 
| getTextTrim | 
| Methods inherited from interface org.dom4j.Branch | 
| addElement, addElement, appendContent, content, elementByID, setProcessingInstructions | 
| Methods inherited from interface org.dom4j.Node | 
| asXPathResult, createXPath, detach, getNodeTypeName, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf | 
| Constructor Detail | 
public UserDataElement(String name)
public UserDataElement(QName qname)
| Method Detail | 
public Object getData()
ElementElement.getText()
getData in interface ElementgetData in class AbstractElementpublic void setData(Object data)
ElementNode.setText(java.lang.String)if it doesn't
setData in interface ElementsetData in class AbstractElementpublic String toString()
toString in class AbstractElementpublic Object clone()
Node
 clone will return a deep clone or if this node is
 read-only then clone will return the same instance.
 
clone in interface Nodeclone in class DefaultElementprotected Object getCopyOfUserData()
protected Element createElement(String name)
createElement in class AbstractElementprotected Element createElement(QName qName)
createElement in class AbstractElement| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||