Save This Page
Home » dom4j-1.6.1 » org.dom4j.util » [javadoc | source]
org.dom4j.util
public class: UserDataElement [javadoc | source]
java.lang.Object
   org.dom4j.tree.AbstractNode
      org.dom4j.tree.AbstractBranch
         org.dom4j.tree.AbstractElement
            org.dom4j.tree.DefaultElement
               org.dom4j.util.UserDataElement

All Implemented Interfaces:
    Element, Branch, Cloneable, Node, Serializable

UserDataElement support the adornment of a user data object on an Element or Attribute instance such that the methods {@link#getData} #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.

Fields inherited from org.dom4j.tree.AbstractElement:
EMPTY_LIST,  EMPTY_ITERATOR,  VERBOSE_TOSTRING,  USE_STRINGVALUE_SEPARATOR
Fields inherited from org.dom4j.tree.AbstractBranch:
DEFAULT_CONTENT_LIST_SIZE
Fields inherited from org.dom4j.tree.AbstractNode:
NODE_TYPE_NAMES
Constructor:
 public UserDataElement(String name) 
 public UserDataElement(QName qname) 
Method from org.dom4j.util.UserDataElement Summary:
clone,   createElement,   createElement,   getCopyOfUserData,   getData,   setData,   toString
Methods from org.dom4j.tree.DefaultElement:
add,   addNewNode,   additionalNamespaces,   additionalNamespaces,   attribute,   attribute,   attribute,   attribute,   attributeCount,   attributeIterator,   attributeList,   attributeList,   attributes,   clearContent,   clone,   contentList,   declaredNamespaces,   element,   element,   element,   getDocument,   getDocumentFactory,   getNamespaceForPrefix,   getNamespaceForURI,   getParent,   getQName,   getStringValue,   getText,   indexOf,   node,   nodeCount,   nodeIterator,   processingInstruction,   processingInstructions,   processingInstructions,   remove,   removeNode,   removeProcessingInstruction,   setAttributeList,   setAttributes,   setContent,   setDocument,   setParent,   setQName,   supportsParent
Methods from org.dom4j.tree.AbstractElement:
accept,   add,   add,   add,   add,   add,   add,   add,   add,   add,   addAttribute,   addAttribute,   addCDATA,   addComment,   addElement,   addEntity,   addNamespace,   addNewNode,   addNewNode,   addNode,   addNode,   addProcessingInstruction,   addProcessingInstruction,   addText,   additionalNamespaces,   additionalNamespaces,   appendAttributes,   asXML,   attribute,   attribute,   attribute,   attribute,   attributeCount,   attributeIterator,   attributeList,   attributeList,   attributeValue,   attributeValue,   attributeValue,   attributeValue,   attributes,   childAdded,   childRemoved,   createAttributeList,   createAttributeList,   createCopy,   createCopy,   createCopy,   createElement,   createElement,   createSingleIterator,   declaredNamespaces,   element,   element,   element,   elementIterator,   elementIterator,   elementIterator,   elementIterator,   elementText,   elementText,   elementTextTrim,   elementTextTrim,   elements,   elements,   elements,   elements,   ensureAttributesCapacity,   getData,   getDocumentFactory,   getName,   getNamespace,   getNamespaceForPrefix,   getNamespaceForURI,   getNamespacePrefix,   getNamespaceURI,   getNamespacesForURI,   getNodeType,   getPath,   getQName,   getQualifiedName,   getStringValue,   getUniquePath,   getXPathNameStep,   getXPathResult,   hasMixedContent,   indexOf,   isRootElement,   isTextOnly,   node,   nodeCount,   nodeIterator,   normalize,   processingInstruction,   processingInstructions,   processingInstructions,   remove,   remove,   remove,   remove,   remove,   remove,   remove,   remove,   remove,   removeNode,   removeProcessingInstruction,   setAttributeValue,   setAttributeValue,   setAttributes,   setData,   setName,   setNamespace,   setText,   toString,   write
Methods from org.dom4j.tree.AbstractBranch:
add,   add,   add,   add,   addElement,   addElement,   addElement,   addElement,   addNode,   addNode,   appendContent,   childAdded,   childRemoved,   content,   contentList,   contentRemoved,   createContentList,   createContentList,   createEmptyList,   createResultList,   createSingleResultList,   elementByID,   elementID,   getContentAsStringValue,   getContentAsText,   getText,   getTextTrim,   hasContent,   indexOf,   invalidNodeTypeAddException,   isReadOnly,   node,   nodeCount,   nodeIterator,   remove,   remove,   remove,   remove,   removeNode,   setProcessingInstructions
Methods from 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,   valueOf,   write
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.dom4j.util.UserDataElement Detail:
 public Object clone() 
 protected Element createElement(String name) 
 protected Element createElement(QName qName) 
 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
 public Object getData() 
 public  void setData(Object data) 
 public String toString()