APIdia Launch Partner
Top Description Fields Constructors Methods
javax.imageio.metadata

public Class IIOMetadataNode

Additional top-level classes in compilation unit: IIODOMException, IIONamedNodeMap, IIONodeList, IIOAttr.

extends Object
implements Element, NodeList
Class Inheritance
All Implemented Interfaces
org.w3c.dom.NodeList, org.w3c.dom.Element, org.w3c.dom.Node
Known Direct Subclasses
javax.imageio.metadata.IIOAttr, com.sun.imageio.plugins.tiff.TIFFFieldNode
Imports
java.io.Serial, java.util.ArrayList, .List, org.w3c.dom.Attr, .DOMException, .Document, .Element, .NamedNodeMap, .Node, .NodeList, .TypeInfo, .UserDataHandler
A class representing a node in a meta-data tree, which implements the org.w3c.dom.Element interface and additionally allows for the storage of non-textual objects via the getUserObject and setUserObject methods.

This class is not intended to be used for general XML processing. In particular, Element nodes created within the Image I/O API are not compatible with those created by Sun's standard implementation of the org.w3.dom API. In particular, the implementation is tuned for simple uses and may not perform well for intensive processing.

Namespaces are ignored in this implementation. The terms "tag name" and "node name" are always considered to be synonymous

Note

The DOM Level 3 specification added a number of new methods to the Node, Element and Attr interfaces that are not of value to the IIOMetadataNode implementation or specification. Calling such methods on an IIOMetadataNode, or an Attr instance returned from an IIOMetadataNode will result in a DOMException being thrown.

See Also
IIOMetadata#getAsTree, IIOMetadata#setFromTree, IIOMetadata#mergeTree

Field Summary

Modifier and TypeField and Description
private List<IIOAttr>
attributes

A List of IIOAttr nodes representing attributes.

private IIOMetadataNode
firstChild

The first (leftmost) child node of this node, or null if this node is a leaf node.

private IIOMetadataNode
lastChild

The last (rightmost) child node of this node, or null if this node is a leaf node.

private IIOMetadataNode
nextSibling

The next (right) sibling node of this node, or null if this node is its parent's last child node.

private String
nodeName

The name of the node as a String.

private String
nodeValue

The value of the node as a String.

private int
numChildren

The number of child nodes.

private IIOMetadataNode
parent

The parent node of this node, or null if this node forms the root of its own tree.

private IIOMetadataNode
previousSibling

The previous (left) sibling node of this node, or null if this node is its parent's first child node.

private Object
userObject

The Object value associated with this node.

Constructor Summary

AccessConstructor and Description
public
IIOMetadataNode()

Constructs an empty IIOMetadataNode.

public
IIOMetadataNode(String
the name of the node, as a String.
nodeName)

Constructs an IIOMetadataNode with a given node name.

Method Summary

Modifier and TypeMethod and Description
public Node

Returns:

the node added.
appendChild(Node
the Node to insert.
newChild)

Implements org.w3c.dom.Node.appendChild.

Adds the node newChild to the end of the list of children of this node.

private void
checkNode(Node node)

Check that the node is either null or an IIOMetadataNode.

public Node

Returns:

the duplicate node.
cloneNode(boolean
if true, recursively clone the subtree under the specified node; if false, clone only the node itself.
deep)

Implements org.w3c.dom.Node.cloneNode.

Returns a duplicate of this node.

public short
compareDocumentPosition(Node other)

Implements org.w3c.dom.Node.compareDocumentPosition.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public String

Returns:

The Attr value as a string, or the empty string if that attribute does not have a specified or default value.
getAttribute(String
The name of the attribute to retrieve.
name)

Implements org.w3c.dom.Element.getAttribute.

Retrieves an attribute value by name.

public Attr
getAttributeNode(String name)

Implements org.w3c.dom.Element.getAttributeNode.

Retrieves an attribute node by name.

public Attr
getAttributeNodeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.getAttributeNodeNS.

Equivalent to getAttributeNode(localName).

public String
getAttributeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.getAttributeNS.

Equivalent to getAttribute(localName).

public NamedNodeMap

Returns:

a NamedNodeMap containing the attributes of this node.
getAttributes()

Implements org.w3c.dom.Node.getAttributes.

Returns a NamedNodeMap containing the attributes of this node.

public String
getBaseURI()

Implements org.w3c.dom.Node.getBaseURI.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public NodeList

Returns:

the children as a NodeList
getChildNodes()

Implements org.w3c.dom.Node.getChildNodes.

Returns a NodeList that contains all children of this node.

public NodeList
getElementsByTagName(String name)

Implements org.w3c.dom.Element.getElementsByTagName.

Returns a NodeList of all descendant Elements with a given tag name, in document order.

private void
getElementsByTagName(String name, List<Node> l)

public NodeList
getElementsByTagNameNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.getElementsByTagNameNS.

Equivalent to getElementsByTagName(localName).

public Object
getFeature(String feature, String version)

Implements org.w3c.dom.Node.getFeature.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public Node

Returns:

the first child, as a Node, or null
getFirstChild()

Implements org.w3c.dom.Node.getFirstChild.

Returns the first child of this node, or null if the node has no children.

public Node

Returns:

the last child, as a Node, or null.
getLastChild()

Implements org.w3c.dom.Node.getLastChild.

Returns the last child of this node, or null if the node has no children.

public int
getLength()

Implements org.w3c.dom.NodeList.getLength.

The number of nodes in the list.

public String

Returns:

the node name, as a String.
getLocalName()

Implements org.w3c.dom.Node.getLocalName.

Equivalent to getNodeName.

public String
getNamespaceURI()

Implements org.w3c.dom.Node.getNamespaceURI.

Returns null, since namespaces are not supported.

public Node

Returns:

the next sibling, as a Node, or null.
getNextSibling()

Implements org.w3c.dom.Node.getNextSibling.

Returns the next sibling of this node, or null if the node has no next sibling.

public String

Returns:

the node name, as a String.
getNodeName()

Implements org.w3c.dom.Node.getNodeName.

Returns the node name associated with this node.

public short

Returns:

the short value ELEMENT_NODE.
getNodeType()

Implements org.w3c.dom.Node.getNodeType.

Returns the node type, which is always ELEMENT_NODE.

public String

Returns:

the node value, as a String.
getNodeValue()

Implements org.w3c.dom.Node.getNodeValue.

Returns the value associated with this node.

public Document

Returns:

null.
getOwnerDocument()

Implements org.w3c.dom.Node.getOwnerDocument.

Returns null, since IIOMetadataNodes do not belong to any Document.

public Node

Returns:

the parent, as a Node.
getParentNode()

Implements org.w3c.dom.Node.getParentNode.

Returns the parent of this node.

public String

Returns:

null.
getPrefix()

Implements org.w3c.dom.Node.getPrefix.

Returns null, since namespaces are not supported.

public Node

Returns:

the previous sibling, as a Node, or null.
getPreviousSibling()

Implements org.w3c.dom.Node.getPreviousSibling.

Returns the previous sibling of this node, or null if this node has no previous sibling.

public TypeInfo
getSchemaTypeInfo()

Implements org.w3c.dom.Element.getSchemaTypeInfo.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public String

Returns:

the node name, as a String
getTagName()

Implements org.w3c.dom.Element.getTagName.

Equivalent to getNodeName.

public String
getTextContent()

Implements org.w3c.dom.Node.getTextContent.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public Object
getUserData(String key)

Implements org.w3c.dom.Node.getUserData.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public Object

Returns:

the user Object.
getUserObject()

Returns the Object value associated with this node.

public boolean
hasAttribute(String name)

Implements org.w3c.dom.Element.hasAttribute.

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

public boolean
hasAttributeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.hasAttributeNS.

Equivalent to hasAttribute(localName).

public boolean
hasAttributes()

Implements org.w3c.dom.Node.hasAttributes.

Returns whether this node (if it is an element) has any attributes.

public boolean

Returns:

true if this node has children.
hasChildNodes()

Implements org.w3c.dom.Node.hasChildNodes.

Returns true if this node has child nodes.

public Node

Returns:

the node being inserted.
insertBefore(Node
the Node to insert.
newChild, Node
the reference Node.
refChild)

Implements org.w3c.dom.Node.insertBefore.

Inserts the node newChild before the existing child node refChild.

public boolean
isDefaultNamespace(String namespaceURI)

Implements org.w3c.dom.Node.isDefaultNamespace.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public boolean
isEqualNode(Node node)

Implements org.w3c.dom.Node.isEqualNode.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public boolean
isSameNode(Node node)

Implements org.w3c.dom.Node.isSameNode.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public boolean

Returns:

false.
isSupported(String
a String, which is ignored.
feature, String
a String, which is ignored.
version)

Implements org.w3c.dom.Node.isSupported.

Returns false since DOM features are not supported.

public Node
item(int index)

Implements org.w3c.dom.NodeList.item.

Returns the indexth item in the collection.

public String
lookupNamespaceURI(String prefix)

Implements org.w3c.dom.Node.lookupNamespaceURI.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public String
lookupPrefix(String namespaceURI)

Implements org.w3c.dom.Node.lookupPrefix.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public void
normalize()

Implements org.w3c.dom.Node.normalize.

Does nothing, since IIOMetadataNodes do not contain Text children.

public void
removeAttribute(String name)

Implements org.w3c.dom.Element.removeAttribute.

Removes an attribute by name.

private void
removeAttribute(String name, boolean checkPresent)

public Attr
removeAttributeNode(Attr oldAttr)

Implements org.w3c.dom.Element.removeAttributeNode.

Removes the specified attribute node.

public void
removeAttributeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.removeAttributeNS.

Equivalent to removeAttribute(localName).

public Node

Returns:

the node removed.
removeChild(Node
the Node to be removed.
oldChild)

Implements org.w3c.dom.Node.removeChild.

Removes the child node indicated by oldChild from the list of children, and returns it.

public Node

Returns:

the node replaced.
replaceChild(Node
the Node to insert.
newChild, Node
the Node to be replaced.
oldChild)

Implements org.w3c.dom.Node.replaceChild.

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

public void
setAttribute(String name, String value)

Implements org.w3c.dom.Element.setAttribute.

Adds a new attribute.

public Attr
setAttributeNode(Attr newAttr)

Implements org.w3c.dom.Element.setAttributeNode.

Adds a new attribute node.

public Attr
setAttributeNodeNS(Attr newAttr)

Implements org.w3c.dom.Element.setAttributeNodeNS.

Equivalent to setAttributeNode(newAttr).

public void
setAttributeNS(String namespaceURI, String qualifiedName, String value)

Implements org.w3c.dom.Element.setAttributeNS.

Equivalent to setAttribute(qualifiedName, value).

public void
setIdAttribute(String name, boolean isId)

Implements org.w3c.dom.Element.setIdAttribute.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public void
setIdAttributeNode(Attr idAttr, boolean isId)

Implements org.w3c.dom.Element.setIdAttributeNode.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public void
setIdAttributeNS(String namespaceURI, String localName, boolean isId)

Implements org.w3c.dom.Element.setIdAttributeNS.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public void
setNodeValue(String nodeValue)

Implements org.w3c.dom.Node.setNodeValue.

Sets the String value associated with this node.

public void
setPrefix(String
a String, which is ignored.
prefix)

Implements org.w3c.dom.Node.setPrefix.

Does nothing, since namespaces are not supported.

public void
setTextContent(String textContent)

Implements org.w3c.dom.Node.setTextContent.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public Object
setUserData(String key, Object data, UserDataHandler handler)

Implements org.w3c.dom.Node.setUserData.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

public void
setUserObject(Object
the user Object.
userObject)

Sets the value associated with this node.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesback to summary
private List<IIOAttr> attributes

A List of IIOAttr nodes representing attributes.

firstChildback to summary
private IIOMetadataNode firstChild

The first (leftmost) child node of this node, or null if this node is a leaf node.

lastChildback to summary
private IIOMetadataNode lastChild

The last (rightmost) child node of this node, or null if this node is a leaf node.

nextSiblingback to summary
private IIOMetadataNode nextSibling

The next (right) sibling node of this node, or null if this node is its parent's last child node.

nodeNameback to summary
private String nodeName

The name of the node as a String.

nodeValueback to summary
private String nodeValue

The value of the node as a String. The Image I/O API typically does not make use of the node value.

numChildrenback to summary
private int numChildren

The number of child nodes.

parentback to summary
private IIOMetadataNode parent

The parent node of this node, or null if this node forms the root of its own tree.

previousSiblingback to summary
private IIOMetadataNode previousSibling

The previous (left) sibling node of this node, or null if this node is its parent's first child node.

userObjectback to summary
private Object userObject

The Object value associated with this node.

Constructor Detail

IIOMetadataNodeback to summary
public IIOMetadataNode()

Constructs an empty IIOMetadataNode.

IIOMetadataNodeback to summary
public IIOMetadataNode(String nodeName)

Constructs an IIOMetadataNode with a given node name.

Parameters
nodeName:String

the name of the node, as a String.

Method Detail

appendChildback to summary
public Node appendChild(Node newChild)

Implements org.w3c.dom.Node.appendChild.

Adds the node newChild to the end of the list of children of this node.

Parameters
newChild:Node

the Node to insert.

Returns:Node

the node added.

Exceptions
IllegalArgumentException:
if newChild is null.
checkNodeback to summary
private void checkNode(Node node) throws DOMException

Check that the node is either null or an IIOMetadataNode.

Exceptions
DOMException:
if node is not null and not an instance of IIOMetadataNode
cloneNodeback to summary
public Node cloneNode(boolean deep)

Implements org.w3c.dom.Node.cloneNode.

Returns a duplicate of this node. The duplicate node has no parent (getParentNode returns null). If a shallow clone is being performed (deep is false), the new node will not have any children or siblings. If a deep clone is being performed, the new node will form the root of a complete cloned subtree.

Parameters
deep:boolean

if true, recursively clone the subtree under the specified node; if false, clone only the node itself.

Returns:Node

the duplicate node.

compareDocumentPositionback to summary
public short compareDocumentPosition(Node other) throws DOMException

Implements org.w3c.dom.Node.compareDocumentPosition.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
getAttributeback to summary
public String getAttribute(String name)

Implements org.w3c.dom.Element.getAttribute.

Retrieves an attribute value by name.

Parameters
name:String

The name of the attribute to retrieve.

Returns:String

The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

getAttributeNodeback to summary
public Attr getAttributeNode(String name)

Implements org.w3c.dom.Element.getAttributeNode.

Doc from org.w3c.dom.Element.getAttributeNode.

Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

getAttributeNodeNSback to summary
public Attr getAttributeNodeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.getAttributeNodeNS.

Equivalent to getAttributeNode(localName).

See Also
setAttributeNodeNS
getAttributeNSback to summary
public String getAttributeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.getAttributeNS.

Equivalent to getAttribute(localName).

See Also
setAttributeNS
getAttributesback to summary
public NamedNodeMap getAttributes()

Implements org.w3c.dom.Node.getAttributes.

Returns a NamedNodeMap containing the attributes of this node.

Returns:NamedNodeMap

a NamedNodeMap containing the attributes of this node.

getBaseURIback to summary
public String getBaseURI() throws DOMException

Implements org.w3c.dom.Node.getBaseURI.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
getChildNodesback to summary
public NodeList getChildNodes()

Implements org.w3c.dom.Node.getChildNodes.

Returns a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

Returns:NodeList

the children as a NodeList

getElementsByTagNameback to summary
public NodeList getElementsByTagName(String name)

Implements org.w3c.dom.Element.getElementsByTagName.

Doc from org.w3c.dom.Element.getElementsByTagName.

Returns a NodeList of all descendant Elements with a given tag name, in document order.

getElementsByTagNameback to summary
private void getElementsByTagName(String name, List<Node> l)
getElementsByTagNameNSback to summary
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.getElementsByTagNameNS.

Equivalent to getElementsByTagName(localName).

getFeatureback to summary
public Object getFeature(String feature, String version) throws DOMException

Implements org.w3c.dom.Node.getFeature.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
getFirstChildback to summary
public Node getFirstChild()

Implements org.w3c.dom.Node.getFirstChild.

Returns the first child of this node, or null if the node has no children.

Returns:Node

the first child, as a Node, or null

getLastChildback to summary
public Node getLastChild()

Implements org.w3c.dom.Node.getLastChild.

Returns the last child of this node, or null if the node has no children.

Returns:Node

the last child, as a Node, or null.

getLengthback to summary
public int getLength()

Implements org.w3c.dom.NodeList.getLength.

Doc from org.w3c.dom.NodeList.getLength.

The number of nodes in the list. The range of valid child node indices is 0 to length-1 inclusive.

getLocalNameback to summary
public String getLocalName()

Implements org.w3c.dom.Node.getLocalName.

Equivalent to getNodeName.

Returns:String

the node name, as a String.

getNamespaceURIback to summary
public String getNamespaceURI() throws DOMException

Implements org.w3c.dom.Node.getNamespaceURI.

Returns null, since namespaces are not supported.

getNextSiblingback to summary
public Node getNextSibling()

Implements org.w3c.dom.Node.getNextSibling.

Returns the next sibling of this node, or null if the node has no next sibling.

Returns:Node

the next sibling, as a Node, or null.

getNodeNameback to summary
public String getNodeName()

Implements org.w3c.dom.Node.getNodeName.

Returns the node name associated with this node.

Returns:String

the node name, as a String.

getNodeTypeback to summary
public short getNodeType()

Implements org.w3c.dom.Node.getNodeType.

Returns the node type, which is always ELEMENT_NODE.

Returns:short

the short value ELEMENT_NODE.

getNodeValueback to summary
public String getNodeValue()

Implements org.w3c.dom.Node.getNodeValue.

Returns the value associated with this node.

Returns:String

the node value, as a String.

getOwnerDocumentback to summary
public Document getOwnerDocument()

Implements org.w3c.dom.Node.getOwnerDocument.

Returns null, since IIOMetadataNodes do not belong to any Document.

Returns:Document

null.

getParentNodeback to summary
public Node getParentNode()

Implements org.w3c.dom.Node.getParentNode.

Returns the parent of this node. A null value indicates that the node is the root of its own tree. To add a node to an existing tree, use one of the insertBefore, replaceChild, or appendChild methods.

Returns:Node

the parent, as a Node.

See Also
insertBefore, replaceChild, appendChild
getPrefixback to summary
public String getPrefix()

Implements org.w3c.dom.Node.getPrefix.

Returns null, since namespaces are not supported.

Returns:String

null.

See Also
setPrefix
getPreviousSiblingback to summary
public Node getPreviousSibling()

Implements org.w3c.dom.Node.getPreviousSibling.

Returns the previous sibling of this node, or null if this node has no previous sibling.

Returns:Node

the previous sibling, as a Node, or null.

getSchemaTypeInfoback to summary
public TypeInfo getSchemaTypeInfo() throws DOMException

Implements org.w3c.dom.Element.getSchemaTypeInfo.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
getTagNameback to summary
public String getTagName()

Implements org.w3c.dom.Element.getTagName.

Equivalent to getNodeName.

Returns:String

the node name, as a String

getTextContentback to summary
public String getTextContent() throws DOMException

Implements org.w3c.dom.Node.getTextContent.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
getUserDataback to summary
public Object getUserData(String key) throws DOMException

Implements org.w3c.dom.Node.getUserData.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
getUserObjectback to summary
public Object getUserObject()

Returns the Object value associated with this node.

Returns:Object

the user Object.

See Also
setUserObject
hasAttributeback to summary
public boolean hasAttribute(String name)

Implements org.w3c.dom.Element.hasAttribute.

Doc from org.w3c.dom.Element.hasAttribute.

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

hasAttributeNSback to summary
public boolean hasAttributeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.hasAttributeNS.

Equivalent to hasAttribute(localName).

hasAttributesback to summary
public boolean hasAttributes()

Implements org.w3c.dom.Node.hasAttributes.

Doc from org.w3c.dom.Node.hasAttributes.

Returns whether this node (if it is an element) has any attributes.

hasChildNodesback to summary
public boolean hasChildNodes()

Implements org.w3c.dom.Node.hasChildNodes.

Returns true if this node has child nodes.

Returns:boolean

true if this node has children.

insertBeforeback to summary
public Node insertBefore(Node newChild, Node refChild)

Implements org.w3c.dom.Node.insertBefore.

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.

Parameters
newChild:Node

the Node to insert.

refChild:Node

the reference Node.

Returns:Node

the node being inserted.

Exceptions
IllegalArgumentException:
if newChild is null.
isDefaultNamespaceback to summary
public boolean isDefaultNamespace(String namespaceURI) throws DOMException

Implements org.w3c.dom.Node.isDefaultNamespace.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
isEqualNodeback to summary
public boolean isEqualNode(Node node) throws DOMException

Implements org.w3c.dom.Node.isEqualNode.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
isSameNodeback to summary
public boolean isSameNode(Node node) throws DOMException

Implements org.w3c.dom.Node.isSameNode.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
isSupportedback to summary
public boolean isSupported(String feature, String version)

Implements org.w3c.dom.Node.isSupported.

Returns false since DOM features are not supported.

Parameters
feature:String

a String, which is ignored.

version:String

a String, which is ignored.

Returns:boolean

false.

itemback to summary
public Node item(int index)

Implements org.w3c.dom.NodeList.item.

Doc from org.w3c.dom.NodeList.item.

Returns the indexth item in the collection. If index is greater than or equal to the number of nodes in the list, this returns null.

lookupNamespaceURIback to summary
public String lookupNamespaceURI(String prefix) throws DOMException

Implements org.w3c.dom.Node.lookupNamespaceURI.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
lookupPrefixback to summary
public String lookupPrefix(String namespaceURI) throws DOMException

Implements org.w3c.dom.Node.lookupPrefix.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
normalizeback to summary
public void normalize()

Implements org.w3c.dom.Node.normalize.

Does nothing, since IIOMetadataNodes do not contain Text children.

removeAttributeback to summary
public void removeAttribute(String name)

Implements org.w3c.dom.Element.removeAttribute.

Doc from org.w3c.dom.Element.removeAttribute.

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.

removeAttributeback to summary
private void removeAttribute(String name, boolean checkPresent)
removeAttributeNodeback to summary
public Attr removeAttributeNode(Attr oldAttr)

Implements org.w3c.dom.Element.removeAttributeNode.

Doc from org.w3c.dom.Element.removeAttributeNode.

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.

removeAttributeNSback to summary
public void removeAttributeNS(String namespaceURI, String localName)

Implements org.w3c.dom.Element.removeAttributeNS.

Equivalent to removeAttribute(localName).

removeChildback to summary
public Node removeChild(Node oldChild)

Implements org.w3c.dom.Node.removeChild.

Removes the child node indicated by oldChild from the list of children, and returns it.

Parameters
oldChild:Node

the Node to be removed.

Returns:Node

the node removed.

Exceptions
IllegalArgumentException:
if oldChild is null.
replaceChildback to summary
public Node replaceChild(Node newChild, Node oldChild)

Implements org.w3c.dom.Node.replaceChild.

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

Parameters
newChild:Node

the Node to insert.

oldChild:Node

the Node to be replaced.

Returns:Node

the node replaced.

Exceptions
IllegalArgumentException:
if newChild is null.
setAttributeback to summary
public void setAttribute(String name, String value)

Implements org.w3c.dom.Element.setAttribute.

Doc from org.w3c.dom.Element.setAttribute.

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.

setAttributeNodeback to summary
public Attr setAttributeNode(Attr newAttr) throws DOMException

Implements org.w3c.dom.Element.setAttributeNode.

Doc from org.w3c.dom.Element.setAttributeNode.

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.

Exceptions
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.
setAttributeNodeNSback to summary
public Attr setAttributeNodeNS(Attr newAttr)

Implements org.w3c.dom.Element.setAttributeNodeNS.

Equivalent to setAttributeNode(newAttr).

See Also
getAttributeNodeNS
setAttributeNSback to summary
public void setAttributeNS(String namespaceURI, String qualifiedName, String value)

Implements org.w3c.dom.Element.setAttributeNS.

Equivalent to setAttribute(qualifiedName, value).

See Also
getAttributeNS
setIdAttributeback to summary
public void setIdAttribute(String name, boolean isId) throws DOMException

Implements org.w3c.dom.Element.setIdAttribute.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
setIdAttributeNodeback to summary
public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException

Implements org.w3c.dom.Element.setIdAttributeNode.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
setIdAttributeNSback to summary
public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException

Implements org.w3c.dom.Element.setIdAttributeNS.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
setNodeValueback to summary
public void setNodeValue(String nodeValue)

Implements org.w3c.dom.Node.setNodeValue.

Sets the String value associated with this node.

setPrefixback to summary
public void setPrefix(String prefix)

Implements org.w3c.dom.Node.setPrefix.

Does nothing, since namespaces are not supported.

Parameters
prefix:String

a String, which is ignored.

See Also
getPrefix
setTextContentback to summary
public void setTextContent(String textContent) throws DOMException

Implements org.w3c.dom.Node.setTextContent.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
setUserDataback to summary
public Object setUserData(String key, Object data, UserDataHandler handler) throws DOMException

Implements org.w3c.dom.Node.setUserData.

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

Exceptions
DOMException:
always.
setUserObjectback to summary
public void setUserObject(Object userObject)

Sets the value associated with this node.

Parameters
userObject:Object

the user Object.

See Also
getUserObject