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

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

Version:

$Revision: 1.12 $

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Object	data	The user data object

Fields inherited from class AbstractElement

USE_STRINGVALUE_SEPARATOR, VERBOSE_TOSTRING

Fields inherited from class AbstractBranch

DEFAULT_CONTENT_LIST_SIZE

Fields inherited from class AbstractNode

NODE_TYPE_NAMES

Fields inherited from interface 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

Modifier and Type	Method	Description
Object	clone()	clone will return a deep clone or if this node is read-only then clone will return the same instance.
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()	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 Element.getText()
void	setData(Object data)	Sets the data value of this element if this element supports data binding or calls Node.setText(String)if it doesn't
String	toString()

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

asXPathResult, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Branch

addElement, addElement, appendContent, content, elementByID, setProcessingInstructions

Methods inherited from interface Element

getTextTrim

Methods inherited from interface Node

asXPathResult, createXPath, detach, getNodeTypeName, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf

Field Details

data

private Object data

The user data object

Constructor Details

UserDataElement

public UserDataElement(String name)

UserDataElement

public UserDataElement(QName qname)

Method Details

getData

public Object getData()

Description copied from interface: Element

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 Element.getText()

Specified by:

getData in interface Element

Overrides:

getData in class AbstractElement

Returns:

DOCUMENT ME!

setData

public void setData(Object data)

Description copied from interface: Element

Sets the data value of this element if this element supports data binding or calls Node.setText(String)if it doesn't

Specified by:

setData in interface Element

Overrides:

setData in class AbstractElement

Parameters:

data - DOCUMENT ME!

toString

public String toString()

Overrides:

toString in class AbstractElement

clone

public Object clone()

Description copied from interface: Node

clone will return a deep clone or if this node is read-only then clone will return the same instance.

Specified by:

clone in interface Node

Overrides:

clone in class DefaultElement

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:

createElement in class AbstractElement

createElement

protected Element createElement(QName qName)

Overrides:

createElement in class AbstractElement