public class IIOMetadataNode extends Object implements Element, NodeList
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.
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
Constructor | Description |
---|---|
IIOMetadataNode() |
Constructs an empty IIOMetadataNode . |
IIOMetadataNode |
Constructs an IIOMetadataNode with a given node name. |
Modifier and Type | Method | Description |
---|---|---|
Node |
appendChild |
Adds the node newChild to the end of the list of children of this node. |
Node |
cloneNode |
Returns a duplicate of this node. |
short |
compareDocumentPosition |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
String |
getAttribute |
Retrieves an attribute value by name. |
Attr |
getAttributeNode |
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS |
Equivalent to getAttributeNode(localName) . |
String |
getAttributeNS |
Equivalent to getAttribute(localName) . |
NamedNodeMap |
getAttributes() |
Returns a NamedNodeMap containing the attributes of this node. |
String |
getBaseURI() |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
NodeList |
getChildNodes() |
Returns a NodeList that contains all children of this node. |
NodeList |
getElementsByTagName |
Returns a NodeList of all descendant Elements with a given tag name, in document order. |
NodeList |
getElementsByTagNameNS |
Equivalent to getElementsByTagName(localName) . |
Object |
getFeature |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
Node |
getFirstChild() |
Returns the first child of this node, or null if the node has no children. |
Node |
getLastChild() |
Returns the last child of this node, or null if the node has no children. |
int |
getLength() |
The number of nodes in the list. |
String |
getLocalName() |
Equivalent to getNodeName . |
String |
getNamespaceURI() |
Returns null , since namespaces are not supported. |
Node |
getNextSibling() |
Returns the next sibling of this node, or null if the node has no next sibling. |
String |
getNodeName() |
Returns the node name associated with this node. |
short |
getNodeType() |
Returns the node type, which is always ELEMENT_NODE . |
String |
getNodeValue() |
Returns the value associated with this node. |
Document |
getOwnerDocument() |
Returns null , since IIOMetadataNode s do not belong to any Document . |
Node |
getParentNode() |
Returns the parent of this node. |
String |
getPrefix() |
Returns null , since namespaces are not supported. |
Node |
getPreviousSibling() |
Returns the previous sibling of this node, or null if this node has no previous sibling. |
TypeInfo |
getSchemaTypeInfo() |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
String |
getTagName() |
Equivalent to getNodeName . |
String |
getTextContent() |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
Object |
getUserData |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
Object |
getUserObject() |
Returns the Object value associated with this node. |
boolean |
hasAttribute |
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. |
boolean |
hasAttributeNS |
Equivalent to hasAttribute(localName) . |
boolean |
hasAttributes() |
Returns whether this node (if it is an element) has any attributes. |
boolean |
hasChildNodes() |
Returns true if this node has child nodes. |
Node |
insertBefore |
Inserts the node newChild before the existing child node refChild . |
boolean |
isDefaultNamespace |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
boolean |
isEqualNode |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
boolean |
isSameNode |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
boolean |
isSupported |
Returns false since DOM features are not supported. |
Node |
item |
Returns the index th item in the collection. |
String |
lookupNamespaceURI |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
String |
lookupPrefix |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
void |
normalize() |
Does nothing, since IIOMetadataNode s do not contain Text children. |
void |
removeAttribute |
Removes an attribute by name. |
Attr |
removeAttributeNode |
Removes the specified attribute node. |
void |
removeAttributeNS |
Equivalent to removeAttribute(localName) . |
Node |
removeChild |
Removes the child node indicated by oldChild from the list of children, and returns it. |
Node |
replaceChild |
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. |
void |
setAttribute |
Adds a new attribute. |
Attr |
setAttributeNode |
Adds a new attribute node. |
Attr |
setAttributeNodeNS |
Equivalent to setAttributeNode(newAttr) . |
void |
setAttributeNS |
Equivalent to setAttribute(qualifiedName, value) . |
void |
setIdAttribute |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
void |
setIdAttributeNode |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
void |
setIdAttributeNS |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
void |
setNodeValue |
Sets the String value associated with this node. |
void |
setPrefix |
Does nothing, since namespaces are not supported. |
void |
setTextContent |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
Object |
setUserData |
This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException . |
void |
setUserObject |
Sets the value associated with this node. |
public IIOMetadataNode()
IIOMetadataNode
.public IIOMetadataNode(String nodeName)
IIOMetadataNode
with a given node name.nodeName
- the name of the node, as a String
.public String getNodeName()
getNodeName
in interface Node
String
.public String getNodeValue()
getNodeValue
in interface Node
String
.public void setNodeValue(String nodeValue)
String
value associated with this node.setNodeValue
in interface Node
public short getNodeType()
ELEMENT_NODE
.getNodeType
in interface Node
short
value ELEMENT_NODE
.public Node getParentNode()
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.getParentNode
in interface Node
Node
.public NodeList getChildNodes()
NodeList
that contains all children of this node. If there are no children, this is a NodeList
containing no nodes.getChildNodes
in interface Node
NodeList
public Node getFirstChild()
null
if the node has no children.getFirstChild
in interface Node
Node
, or null
public Node getLastChild()
null
if the node has no children.getLastChild
in interface Node
Node
, or null
.public Node getPreviousSibling()
null
if this node has no previous sibling.getPreviousSibling
in interface Node
Node
, or null
.public Node getNextSibling()
null
if the node has no next sibling.getNextSibling
in interface Node
Node
, or null
.public NamedNodeMap getAttributes()
NamedNodeMap
containing the attributes of this node.getAttributes
in interface Node
NamedNodeMap
containing the attributes of this node.public Document getOwnerDocument()
null
, since IIOMetadataNode
s do not belong to any Document
.getOwnerDocument
in interface Node
null
.public Node insertBefore(Node newChild, Node refChild)
newChild
before the existing child node refChild
. If refChild
is null
, insert newChild
at the end of the list of children.insertBefore
in interface Node
newChild
- the Node
to insert.refChild
- the reference Node
.IllegalArgumentException
- if newChild
is null
.public Node replaceChild(Node newChild, Node oldChild)
oldChild
with newChild
in the list of children, and returns the oldChild
node.replaceChild
in interface Node
newChild
- the Node
to insert.oldChild
- the Node
to be replaced.IllegalArgumentException
- if newChild
is null
.public Node removeChild(Node oldChild)
oldChild
from the list of children, and returns it.removeChild
in interface Node
oldChild
- the Node
to be removed.IllegalArgumentException
- if oldChild
is null
.public Node appendChild(Node newChild)
newChild
to the end of the list of children of this node.appendChild
in interface Node
newChild
- the Node
to insert.IllegalArgumentException
- if newChild
is null
.public boolean hasChildNodes()
true
if this node has child nodes.hasChildNodes
in interface Node
true
if this node has children.public Node cloneNode(boolean deep)
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.public void normalize()
IIOMetadataNode
s do not contain Text
children.public boolean isSupported(String feature, String version)
false
since DOM features are not supported.isSupported
in interface Node
feature
- a String
, which is ignored.version
- a String
, which is ignored.false
.public String getNamespaceURI() throws DOMException
null
, since namespaces are not supported.getNamespaceURI
in interface Node
DOMException
public String getPrefix()
null
, since namespaces are not supported.public void setPrefix(String prefix)
public String getLocalName()
getNodeName
.getLocalName
in interface Node
String
.public String getTagName()
getNodeName
.getTagName
in interface Element
String
public String getAttribute(String name)
getAttribute
in interface Element
name
- The name of the attribute to retrieve.Attr
value as a string, or the empty string if that attribute does not have a specified or default value.public String getAttributeNS(String namespaceURI, String localName)
getAttribute(localName)
.getAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.Attr
value as a string, or the empty string if that attribute does not have a specified or default value.public void setAttribute(String name, String value)
Element
Attr
node plus any Text
and EntityReference
nodes, build the appropriate subtree, and use setAttributeNode
to assign it as the value of an attribute. setAttributeNS
method.setAttribute
in interface Element
name
- The name of the attribute to create or alter.value
- Value to set in string form.public void setAttributeNS(String namespaceURI, String qualifiedName, String value)
setAttribute(qualifiedName, value)
.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.public void removeAttribute(String name)
Element
Document.normalizeDocument()
to guarantee this information is up-to-date. removeAttributeNS
method.removeAttribute
in interface Element
name
- The name of the attribute to remove.public void removeAttributeNS(String namespaceURI, String localName)
removeAttribute(localName)
.removeAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to remove.localName
- The local name of the attribute to remove.public Attr getAttributeNode(String name)
Element
getAttributeNodeNS
method.getAttributeNode
in interface Element
name
- The name (nodeName
) of the attribute to retrieve.Attr
node with the specified name ( nodeName
) or null
if there is no such attribute.public Attr getAttributeNodeNS(String namespaceURI, String localName)
getAttributeNode(localName)
.getAttributeNodeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.Attr
node with the specified attribute local name and namespace URI or null
if there is no such attribute.public Attr setAttributeNode(Attr newAttr) throws DOMException
Element
nodeName
) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect. setAttributeNodeNS
method.setAttributeNode
in interface Element
newAttr
- The Attr
node to add to the attribute list.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. newAttr
is already an attribute of another Element
object. The DOM user must explicitly clone Attr
nodes to re-use them in other elements.public Attr setAttributeNodeNS(Attr newAttr)
setAttributeNode(newAttr)
.setAttributeNodeNS
in interface Element
newAttr
- The Attr
node to add to the attribute list.newAttr
attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr
node is returned, otherwise null
is returned.public Attr removeAttributeNode(Attr oldAttr)
Element
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.Attr
node that was removed.public NodeList getElementsByTagName(String name)
Element
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.Element
nodes.public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
getElementsByTagName(localName)
.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.NodeList
object containing all the matched Elements
.public boolean hasAttributes()
Node
hasAttributes
in interface Node
true
if this node has any attributes, false
otherwise.public boolean hasAttribute(String name)
Element
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.public boolean hasAttributeNS(String namespaceURI, String localName)
hasAttribute(localName)
.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.public int getLength()
NodeList
length-1
inclusive.public Node item(int index)
NodeList
index
th item in the collection. If index
is greater than or equal to the number of nodes in the list, this returns null
.public Object getUserObject()
Object
value associated with this node.Object
.public void setUserObject(Object userObject)
userObject
- the user Object
.public void setIdAttribute(String name, boolean isId) throws DOMException
IIOMetadataNode
and will throw a DOMException
.setIdAttribute
in interface Element
name
- The name of the attribute.isId
- Whether the attribute is a of type ID.DOMException
- always.public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
IIOMetadataNode
and will throw a DOMException
.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
- always.public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
IIOMetadataNode
and will throw a DOMException
.setIdAttributeNode
in interface Element
idAttr
- The attribute node.isId
- Whether the attribute is a of type ID.DOMException
- always.public TypeInfo getSchemaTypeInfo() throws DOMException
IIOMetadataNode
and will throw a DOMException
.getSchemaTypeInfo
in interface Element
DOMException
- always.public Object setUserData(String key, Object data, UserDataHandler handler) throws DOMException
IIOMetadataNode
and will throw a DOMException
.setUserData
in interface Node
key
- The key to associate the object to.data
- The object to associate to the given key, or null
to remove any existing association to that key.handler
- The handler to associate to that key, or null
.DOMUserData
previously associated to the given key on this node, or null
if there was none.DOMException
- always.public Object getUserData(String key) throws DOMException
IIOMetadataNode
and will throw a DOMException
.getUserData
in interface Node
key
- The key the object is associated to.DOMUserData
associated to the given key on this node, or null
if there was none.DOMException
- always.public Object getFeature(String feature, String version) throws DOMException
IIOMetadataNode
and will throw a DOMException
.getFeature
in interface Node
feature
- The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.version
- This is the version number of the feature to test.null
if there is no object which implements interfaces associated with that feature. If the DOMObject
returned by this method implements the Node
interface, it must delegate to the primary core Node
and not return results inconsistent with the primary core Node
such as attributes, childNodes, etc.DOMException
- always.public boolean isSameNode(Node node) throws DOMException
IIOMetadataNode
and will throw a DOMException
.isSameNode
in interface Node
node
- The node to test against.true
if the nodes are the same, false
otherwise.DOMException
- always.public boolean isEqualNode(Node node) throws DOMException
IIOMetadataNode
and will throw a DOMException
.isEqualNode
in interface Node
node
- The node to compare equality with.true
if the nodes are equal, false
otherwise.DOMException
- always.public String lookupNamespaceURI(String prefix) throws DOMException
IIOMetadataNode
and will throw a DOMException
.lookupNamespaceURI
in interface Node
prefix
- The prefix to look for. If this parameter is null
, the method will return the default namespace URI if any.null
if none is found.DOMException
- always.public boolean isDefaultNamespace(String namespaceURI) throws DOMException
IIOMetadataNode
and will throw a DOMException
.isDefaultNamespace
in interface Node
namespaceURI
- The namespace URI to look for.true
if the specified namespaceURI
is the default namespace, false
otherwise.DOMException
- always.public String lookupPrefix(String namespaceURI) throws DOMException
IIOMetadataNode
and will throw a DOMException
.lookupPrefix
in interface Node
namespaceURI
- The namespace URI to look for.null
if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.DOMException
- always.public String getTextContent() throws DOMException
IIOMetadataNode
and will throw a DOMException
.getTextContent
in interface Node
DOMException
- always.public void setTextContent(String textContent) throws DOMException
IIOMetadataNode
and will throw a DOMException
.setTextContent
in interface Node
DOMException
- always.public short compareDocumentPosition(Node other) throws DOMException
IIOMetadataNode
and will throw a DOMException
.compareDocumentPosition
in interface Node
other
- The node to compare against the reference node.DOMException
- always.public String getBaseURI() throws DOMException
IIOMetadataNode
and will throw a DOMException
.getBaseURI
in interface Node
DOMException
- always.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/imageio/metadata/IIOMetadataNode.html