Top Description Fields Constructors Methods
org.dom4j.util

public Class UserDataElement

extends DefaultElement
Class Inheritance
Imports
org.dom4j.Element, .QName, org.dom4j.tree.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.

Author
James Strachan
Version
$Revision: 1.12 $

Field Summary

Modifier and TypeField and Description
private Object
data

The user data object

Constructor Summary

AccessConstructor and Description
public
UserDataElement(String name)

public
UserDataElement(QName qname)

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides org.dom4j.tree.DefaultElement.clone.

Implements org.dom4j.Node.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)

Overrides org.dom4j.tree.AbstractElement.createElement.

protected Element
createElement(QName qName)

Overrides org.dom4j.tree.AbstractElement.createElement.

protected Object

Returns:

DOCUMENT ME!
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()

Overrides org.dom4j.tree.AbstractElement.getData.

Implements org.dom4j.Element.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 getText
public void
setData(Object
DOCUMENT ME!
data)

Overrides org.dom4j.tree.AbstractElement.setData.

Implements org.dom4j.Element.setData.

Sets the data value of this element if this element supports data binding or calls setTextif it doesn't
public String
toString()

Overrides org.dom4j.tree.AbstractElement.toString.

Returns a string representation of the object.
Inherited from org.dom4j.tree.DefaultElement:
addadditionalNamespacesadditionalNamespacesaddNewNodeattributeattributeattributeattributeattributeCountattributeIteratorattributeListattributeListattributesclearContentcontentListdeclaredNamespaceselementelementelementgetDocumentgetDocumentFactorygetNamespaceForPrefixgetNamespaceForURIgetParentgetQNamegetStringValuegetTextindexOfnodenodeCountnodeIteratorprocessingInstructionprocessingInstructionsprocessingInstructionsremoveremoveNoderemoveProcessingInstructionsetAttributeListsetAttributessetContentsetDocumentsetParentsetQNamesupportsParent

Field Detail

databack to summary
private Object data

The user data object

Constructor Detail

UserDataElementback to summary
public UserDataElement(String name)
UserDataElementback to summary
public UserDataElement(QName qname)

Method Detail

cloneback to summary
public Object clone()

Overrides org.dom4j.tree.DefaultElement.clone.

Implements org.dom4j.Node.clone.

Doc from org.dom4j.Node.clone.

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

Returns:Object

a deep clone of myself or myself if I am read only.

createElementback to summary
protected Element createElement(String name)

Overrides org.dom4j.tree.AbstractElement.createElement.

createElementback to summary
protected Element createElement(QName qName)

Overrides org.dom4j.tree.AbstractElement.createElement.

getCopyOfUserDataback to summary
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:Object

DOCUMENT ME!

getDataback to summary
public Object getData()

Overrides org.dom4j.tree.AbstractElement.getData.

Implements org.dom4j.Element.getData.

Doc from org.dom4j.Element.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 getText

Returns:Object

DOCUMENT ME!

setDataback to summary
public void setData(Object data)

Overrides org.dom4j.tree.AbstractElement.setData.

Implements org.dom4j.Element.setData.

Doc from org.dom4j.Element.setData.

Sets the data value of this element if this element supports data binding or calls setTextif it doesn't

Parameters
data:Object

DOCUMENT ME!

toStringback to summary
public String toString()

Overrides org.dom4j.tree.AbstractElement.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.