getAttribute
public String getAttribute(String name)
Retrieves an attribute value by name.
- getAttribute in interface Element
name
- The name of the attribute to retrieve.
- The
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.
getAttributeNS
public String getAttributeNS(String namespaceURI,
String localName)
Retrieves an attribute value by local name and namespace URI.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- getAttributeNS in interface Element
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.
- The
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
getAttributeNode
public Attr getAttributeNode(String name)
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI,
use the getAttributeNodeNS
method.
- getAttributeNode in interface Element
name
- The name (nodeName
) of the attribute to
retrieve.
- The
Attr
node with the specified name (
nodeName
) or null
if there is no such
attribute.
getAttributeNodeNS
public Attr getAttributeNodeNS(String namespaceURI,
String localName)
Retrieves an
Attr
node by local name and namespace URI.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- getAttributeNodeNS in interface Element
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.
- The
Attr
node with the specified attribute local
name and namespace URI or null
if there is no such
attribute.
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
getElementsByTagName
public NodeList getElementsByTagName(String name)
Returns a NodeList
of all descendant Elements
with a given tag name, in document order.
- getElementsByTagName in interface Element
name
- The name of the tag to match on. The special value "*"
matches all tags.
- A list of matching
Element
nodes.
getElementsByTagNameNS
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
Returns a NodeList
of all the descendant
Elements
with a given local name and namespace URI in
document order.
- getElementsByTagNameNS in interface Element
namespaceURI
- The namespace URI of the elements to match on. The
special value "*" matches all namespaces.localName
- The local name of the elements to match on. The
special value "*" matches all local names.
- A new
NodeList
object containing all the matched
Elements
.
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
getLength
public int getLength()
The number of nodes in the list. The range of valid child node indices
is 0 to length-1
inclusive.
- getLength in interface NodeList
getTagName
public String getTagName()
The name of the element. If
Node.localName
is different
from
null
, this attribute is a qualified name. For
example, in:
<elementExample id="demo"> ...
</elementExample> ,
tagName
has the value
"elementExample"
. Note that this is case-preserving in
XML, as are all of the operations of the DOM. The HTML DOM returns
the
tagName
of an HTML element in the canonical
uppercase form, regardless of the case in the source HTML document.
- getTagName in interface Element
hasAttribute
public boolean hasAttribute(String name)
Returns true
when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
- hasAttribute in interface Element
name
- The name of the attribute to look for.
true
if an attribute with the given name is
specified on this element or has a default value, false
otherwise.
hasAttributeNS
public boolean hasAttributeNS(String namespaceURI,
String localName)
Returns
true
when an attribute with a given local name and
namespace URI is specified on this element or has a default value,
false
otherwise.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- hasAttributeNS in interface Element
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.
true
if an attribute with the given local name
and namespace URI is specified or has a default value on this
element, false
otherwise.
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
item
public Node item(int index)
Returns the index
th item in the collection. If
index
is greater than or equal to the number of nodes in
the list, this returns null
.
- item in interface NodeList
index
- Index into the collection.
- The node at the
index
th position in the
NodeList
, or null
if that is not a valid
index.
removeAttribute
public void removeAttribute(String name)
Removes an attribute by name. If a default value for the removed
attribute is defined in the DTD, a new attribute immediately appears
with the default value as well as the corresponding namespace URI,
local name, and prefix when applicable. The implementation may handle
default values from other schemas similarly but applications should
use Document.normalizeDocument()
to guarantee this
information is up-to-date.
If no attribute with this name is found, this method has no effect.
To remove an attribute by local name and namespace URI, use the
removeAttributeNS
method.
- removeAttribute in interface Element
name
- The name of the attribute to remove.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
removeAttributeNS
public void removeAttributeNS(String namespaceURI,
String localName)
Removes an attribute by local name and namespace URI. If a default
value for the removed attribute is defined in the DTD, a new
attribute immediately appears with the default value as well as the
corresponding namespace URI, local name, and prefix when applicable.
The implementation may handle default values from other schemas
similarly but applications should use
Document.normalizeDocument()
to guarantee this
information is up-to-date.
If no attribute with this local name and namespace URI is found,
this method has no effect.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- removeAttributeNS in interface Element
namespaceURI
- The namespace URI of the attribute to remove.localName
- The local name of the attribute to remove.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
removeAttributeNode
public Attr removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. If a default value for the
removed Attr
node is defined in the DTD, a new node
immediately appears with the default value as well as the
corresponding namespace URI, local name, and prefix when applicable.
The implementation may handle default values from other schemas
similarly but applications should use
Document.normalizeDocument()
to guarantee this
information is up-to-date.
- removeAttributeNode in interface Element
oldAttr
- The Attr
node to remove from the attribute
list.
- The
Attr
node that was removed.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr
is not an attribute
of the element.
setAttribute
public void setAttribute(String name,
String value)
Adds a new attribute. If an attribute with that name is already present
in the element, its value is changed to be that of the value
parameter. This value is a simple string; it is not parsed as it is
being set. So any markup (such as syntax to be recognized as an
entity reference) is treated as literal text, and needs to be
appropriately escaped by the implementation when it is written out.
In order to assign an attribute value that contains entity
references, the user must create an Attr
node plus any
Text
and EntityReference
nodes, build the
appropriate subtree, and use setAttributeNode
to assign
it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use
the setAttributeNS
method.
- setAttribute in interface Element
name
- The name of the attribute to create or alter.value
- Value to set in string form.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
setAttributeNS
public void setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
Adds a new attribute. If an attribute with the same local name and
namespace URI is already present on the element, its prefix is
changed to be the prefix part of the
qualifiedName
, and
its value is changed to be the
value
parameter. This
value is a simple string; it is not parsed as it is being set. So any
markup (such as syntax to be recognized as an entity reference) is
treated as literal text, and needs to be appropriately escaped by the
implementation when it is written out. In order to assign an
attribute value that contains entity references, the user must create
an
Attr
node plus any
Text
and
EntityReference
nodes, build the appropriate subtree,
and use
setAttributeNodeNS
or
setAttributeNode
to assign it as the value of an
attribute.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- setAttributeNS in interface Element
namespaceURI
- The namespace URI of the attribute to create or
alter.qualifiedName
- The qualified name of the attribute to create or
alter.value
- The value to set in string form.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name is not
an XML name according to the XML version in use specified in the
Document.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the qualifiedName
is
malformed per the Namespaces in XML specification, if the
qualifiedName
has a prefix and the
namespaceURI
is null
, if the
qualifiedName
has a prefix that is "xml" and the
namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace", if the qualifiedName
or its prefix is "xmlns" and the
namespaceURI
is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI
is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
setAttributeNode
public Attr setAttributeNode(Attr newAttr)
Adds a new attribute node. If an attribute with that name (
nodeName
) is already present in the element, it is
replaced by the new one. Replacing an attribute node by itself has no
effect.
To add a new attribute node with a qualified name and namespace
URI, use the setAttributeNodeNS
method.
- setAttributeNode in interface Element
newAttr
- The Attr
node to add to the attribute list.
- If the
newAttr
attribute replaces an existing
attribute, the replaced Attr
node is returned,
otherwise null
is returned.
DOMException
- WRONG_DOCUMENT_ERR: Raised if newAttr
was created from a
different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr
is already an
attribute of another Element
object. The DOM user must
explicitly clone Attr
nodes to re-use them in other
elements.
setAttributeNodeNS
public Attr setAttributeNodeNS(Attr newAttr)
Adds a new attribute. If an attribute with that local name and that
namespace URI is already present in the element, it is replaced by
the new one. Replacing an attribute node by itself has no effect.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- setAttributeNodeNS in interface Element
newAttr
- The Attr
node to add to the attribute list.
- If the
newAttr
attribute replaces an existing
attribute with the same local name and namespace URI, the replaced
Attr
node is returned, otherwise null
is
returned.
DOMException
- WRONG_DOCUMENT_ERR: Raised if newAttr
was created from a
different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr
is already an
attribute of another Element
object. The DOM user must
explicitly clone Attr
nodes to re-use them in other
elements.
NOT_SUPPORTED_ERR: May be raised if the implementation does not
support the feature "XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).
setIdAttribute
public void setIdAttribute(String name,
boolean isId)
throws DOMException
If the parameter isId
is true
, this method
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId
and the behavior
of Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified Attr
node. Use the value false
for the parameter
isId
to undeclare an attribute for being a
user-determined ID attribute.
To specify an attribute by local name and namespace URI, use the
setIdAttributeNS
method.
- setIdAttribute in interface Element
name
- The name of the attribute.isId
- Whether the attribute is a of type ID.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute
of this element.
setIdAttributeNS
public void setIdAttributeNS(String namespaceURI,
String localName,
boolean isId)
throws DOMException
If the parameter isId
is true
, this method
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId
and the behavior
of Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified Attr
node. Use the value false
for the parameter
isId
to undeclare an attribute for being a
user-determined ID attribute.
- setIdAttributeNS in interface Element
namespaceURI
- The namespace URI of the attribute.localName
- The local name of the attribute.isId
- Whether the attribute is a of type ID.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute
of this element.
setIdAttributeNode
public void setIdAttributeNode(Attr idAttr,
boolean isId)
throws DOMException
If the parameter isId
is true
, this method
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId
and the behavior
of Document.getElementById
, but does not change any
schema that may be in use, in particular this does not affect the
Attr.schemaTypeInfo
of the specified Attr
node. Use the value false
for the parameter
isId
to undeclare an attribute for being a
user-determined ID attribute.
- setIdAttributeNode in interface Element
idAttr
- The attribute node.isId
- Whether the attribute is a of type ID.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute
of this element.
IIOMetadataNode.java --
Copyright (C) 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.