org.dom4j.util

Class UserDataElement

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

public class UserDataElement
extends org.dom4j.tree.DefaultElement

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.
Version:
$Revision: 1.12 $
Author:
James Strachan

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(String name)
UserDataElement(QName qname)

Method Summary

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
Object
getData()
void
setData(Object data)
String
toString()

Methods inherited from class 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 inherited from class 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 inherited from class 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 inherited from class 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

Constructor Details

UserDataElement

public UserDataElement(String name)

UserDataElement

public UserDataElement(QName qname)

Method Details

clone

public Object clone()
Specified by:
clone in interface Node
Overrides:
clone in interface org.dom4j.tree.DefaultElement

createElement

protected Element createElement(String name)
Overrides:
createElement in interface org.dom4j.tree.AbstractElement

createElement

protected Element createElement(QName qName)
Overrides:
createElement in interface org.dom4j.tree.AbstractElement

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!

getData

public Object getData()
Specified by:
getData in interface Element
Overrides:
getData in interface org.dom4j.tree.AbstractElement

setData

public void setData(Object data)
Specified by:
setData in interface Element
Overrides:
setData in interface org.dom4j.tree.AbstractElement

toString

public String toString()
Overrides:
toString in interface org.dom4j.tree.AbstractElement

Copyright B) 2005 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo