Package org.dom4j.util
Class UserDataElement
- 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:
 Serializable,Cloneable,Branch,Element,Node
public class UserDataElement extends DefaultElement
UserDataElementsupport the adornment of a user data object on an Element or Attribute instance such that the methodsgetData()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.- See Also:
 - Serialized Form
 
 
- 
- 
Field Summary
- 
Fields inherited from class org.dom4j.tree.AbstractElement
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
Constructors Constructor Description UserDataElement(String name)UserDataElement(QName qname) 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()clonewill return a deep clone or if this node is read-only then clone will return the same instance.protected ElementcreateElement(String name)protected ElementcreateElement(QName qName)protected ObjectgetCopyOfUserData()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 dataObjectgetData()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 asElement.getText()voidsetData(Object data)Sets the data value of this element if this element supports data binding or callsNode.setText(java.lang.String)if it doesn'tStringtoString()- 
Methods inherited from class org.dom4j.tree.DefaultElement
add, additionalNamespaces, additionalNamespaces, addNewNode, attribute, attribute, attribute, attribute, attributeCount, attributeIterator, attributeList, attributeList, attributes, clearContent, 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 inherited from class org.dom4j.tree.AbstractElement
accept, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addEntity, addNamespace, addNewNode, addNode, addNode, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, asXML, attributeValue, attributeValue, attributeValue, attributeValue, childAdded, childRemoved, createAttributeList, createAttributeList, createCopy, createCopy, createCopy, createSingleIterator, elementIterator, elementIterator, elementIterator, elementIterator, elements, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, ensureAttributesCapacity, getName, getNamespace, getNamespacePrefix, getNamespacesForURI, getNamespaceURI, getNodeType, getPath, getQName, getQualifiedName, getUniquePath, getXPathNameStep, getXPathResult, hasMixedContent, isRootElement, isTextOnly, normalize, remove, remove, remove, remove, remove, remove, remove, remove, setAttributes, setAttributeValue, setAttributeValue, setName, setNamespace, setText, write 
- 
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.Branch
addElement, addElement, appendContent, content, elementByID, setProcessingInstructions 
- 
Methods inherited from interface org.dom4j.Element
getTextTrim 
- 
Methods inherited from interface org.dom4j.Node
asXPathResult, createXPath, detach, getNodeTypeName, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf 
 - 
 
 - 
 
- 
- 
Method Detail
- 
getData
public Object getData()
Description copied from interface:ElementAccesses 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 asElement.getText()- Specified by:
 getDatain interfaceElement- Overrides:
 getDatain classAbstractElement- Returns:
 - DOCUMENT ME!
 
 
- 
setData
public void setData(Object data)
Description copied from interface:ElementSets the data value of this element if this element supports data binding or callsNode.setText(java.lang.String)if it doesn't- Specified by:
 setDatain interfaceElement- Overrides:
 setDatain classAbstractElement- Parameters:
 data- DOCUMENT ME!
 
- 
toString
public String toString()
- Overrides:
 toStringin classAbstractElement
 
- 
clone
public Object clone()
Description copied from interface:Nodeclonewill return a deep clone or if this node is read-only then clone will return the same instance.- Specified by:
 clonein interfaceNode- Overrides:
 clonein classDefaultElement- Returns:
 - a deep clone of myself or myself if I am read only.
 
 
- 
getCopyOfUserData
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- Returns:
 - DOCUMENT ME!
 
 
- 
createElement
protected Element createElement(String name)
- Overrides:
 createElementin classAbstractElement
 
- 
createElement
protected Element createElement(QName qName)
- Overrides:
 createElementin classAbstractElement
 
 - 
 
 -