Interface Attribute
- All Known Implementing Classes:
AbstractAttribute
,BeanAttribute
,DefaultAttribute
,DOMAttribute
,FlyweightAttribute
,UserDataAttribute
Attribute
defines an XML attribute. An attribute may have a
name, an optional namespace and a value.
- Version:
- $Revision: 1.9 $
- Author:
- James Strachan
-
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptiongetData()
Accesses the data of this attribute which may implement data typing bindings such asXML Schema
orJava Bean
bindings or will return the same value asNode.getText()
.Returns theNamespace
of this element if one exists otherwise null is returned returned.Returns the namespace prefix of this element if one exists otherwise an emptyString
is returned.Returns the URI mapped to the namespace of this element if one exists otherwise an emptyString
is returned.getQName()
Returns theQName
of this attribute which represents the local name, the qualified name and theNamespace
.Returns the fully qualified name of this element.getValue()
Returns the value of the attribute.void
Sets the data value of this attribute if this element supports data binding or callsNode.setText(String)
if it doesn't.void
setNamespace
(Namespace namespace) Sets theNamespace
of this element or if this element is read only then anUnsupportedOperationException
is thrown.void
Sets the value of this attribute or this method will throw anUnsupportedOperationException
if it is read-only.Methods inherited from interface org.dom4j.Node
accept, asXML, asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getPath, getStringValue, getText, getUniquePath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write
-
Method Details
-
getQName
QName getQName()Returns the
QName
of this attribute which represents the local name, the qualified name and theNamespace
.- Returns:
- the
QName
associated with this attribute
-
getNamespace
Namespace getNamespace()Returns the
Namespace
of this element if one exists otherwise null is returned returned.- Returns:
- the
Namespace
associated with this node
-
setNamespace
Sets the
Namespace
of this element or if this element is read only then anUnsupportedOperationException
is thrown.- Parameters:
namespace
- is theNamespace
to associate with this element
-
getNamespacePrefix
String getNamespacePrefix()Returns the namespace prefix of this element if one exists otherwise an empty
String
is returned.- Returns:
- the prefix of the
Namespace
of this element or an emptyString
-
getNamespaceURI
String getNamespaceURI()Returns the URI mapped to the namespace of this element if one exists otherwise an empty
String
is returned.- Returns:
- the URI for the
Namespace
of this element or an emptyString
-
getQualifiedName
String getQualifiedName()Returns the fully qualified name of this element.
This will be the same as the value returned from
Node.getName()
if this element has no namespace attached to this element or an expression of the formgetNamespacePrefix() + ":" + getName()
will be returned.- Returns:
- the fully qualified name of the element
-
getValue
String getValue()Returns the value of the attribute. This method returns the same value as the
Node.getText()
method.- Returns:
- the value of the attribute
-
setValue
Sets the value of this attribute or this method will throw an
UnsupportedOperationException
if it is read-only.- Parameters:
value
- is the new value of this attribute
-
getData
Object getData()Accesses the data of this attribute which may implement data typing bindings such as
XML Schema
orJava Bean
bindings or will return the same value asNode.getText()
.- Returns:
- the attribute data
-
setData
Sets the data value of this attribute if this element supports data binding or calls
Node.setText(String)
if it doesn't.- Parameters:
data
- the attribute data
-