public class IIOMetadataNode extends Object implements Element, NodeList
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.
IIOMetadata.getAsTree(java.lang.String), IIOMetadata.setFromTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node)
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 public IIOMetadataNode()
Constructs an empty IIOMetadataNode.
public IIOMetadataNode(String nodeName)
Constructs an IIOMetadataNode with a given node name.
nodeName - the name of the node, as a String.public String getNodeName()
Returns the node name associated with this node.
getNodeName in interface Node
String.public String getNodeValue()
Returns the value associated with this node.
getNodeValue in interface Node
String.public void setNodeValue(String nodeValue)
Sets the String value associated with this node.
setNodeValue in interface Node
public short getNodeType()
Returns the node type, which is always ELEMENT_NODE.
getNodeType in interface Node
short value ELEMENT_NODE.public 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.
getParentNode in interface Node
Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), replaceChild(org.w3c.dom.Node, org.w3c.dom.Node), appendChild(org.w3c.dom.Node)
public NodeList getChildNodes()
Returns a 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()
Returns the first child of this node, or null if the node has no children.
getFirstChild in interface Node
Node, or null
public Node getLastChild()
Returns the last child of this node, or null if the node has no children.
getLastChild in interface Node
Node, or null.public Node getPreviousSibling()
Returns the previous sibling of this node, or null if this node has no previous sibling.
getPreviousSibling in interface Node
Node, or null.public Node getNextSibling()
Returns the next sibling of this node, or null if the node has no next sibling.
getNextSibling in interface Node
Node, or null.public NamedNodeMap getAttributes()
Returns a NamedNodeMap containing the attributes of this node.
getAttributes in interface Node
NamedNodeMap containing the attributes of this node.public Document getOwnerDocument()
Returns null, since IIOMetadataNodes do not belong to any Document.
getOwnerDocument in interface Node
null.public Node insertBefore(Node newChild,
Node refChild) Inserts the node 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) Replaces the child node 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)
Removes the child node indicated by 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)
Adds the node 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()
Returns true if this node has child nodes.
hasChildNodes in interface Node
true if this node has children.public Node cloneNode(boolean deep)
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.
cloneNode in interface Node
deep - if true, recursively clone the subtree under the specified node; if false, clone only the node itself.public void normalize()
Does nothing, since IIOMetadataNodes do not contain Text children.
public boolean isSupported(String feature,
String version) Returns 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 Returns null, since namespaces are not supported.
getNamespaceURI in interface Node
DOMExceptionpublic String getPrefix()
Returns null, since namespaces are not supported.
getPrefix in interface Node
null.setPrefix(java.lang.String)public void setPrefix(String prefix)
Does nothing, since namespaces are not supported.
setPrefix in interface Node
prefix - a String, which is ignored.getPrefix()public String getLocalName()
Equivalent to getNodeName.
getLocalName in interface Node
String.public String getTagName()
Equivalent to getNodeName.
getTagName in interface Element
String
public String getAttribute(String name)
Retrieves an attribute value by 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) Equivalent to 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.setAttributeNS(java.lang.String, java.lang.String, java.lang.String)public void setAttribute(String name,
String value) Description copied from interface: Element
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.public void setAttributeNS(String namespaceURI,
String qualifiedName,
String value) Equivalent to 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.getAttributeNS(java.lang.String, java.lang.String)public void removeAttribute(String name)
Description copied from interface: Element
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.public void removeAttributeNS(String namespaceURI,
String localName) Equivalent to 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)
Description copied from interface: Element
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.Attr node with the specified name ( nodeName) or null if there is no such attribute.public Attr getAttributeNodeNS(String namespaceURI,
String localName) Equivalent to 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.setAttributeNodeNS(org.w3c.dom.Attr)public Attr setAttributeNode(Attr newAttr)
throws DOMException Description copied from interface: Element
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.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)
Equivalent to 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.getAttributeNodeNS(java.lang.String, java.lang.String)public Attr removeAttributeNode(Attr oldAttr)
Description copied from interface: Element
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.Attr node that was removed.public NodeList getElementsByTagName(String name)
Description copied from interface: Element
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.Element nodes.public NodeList getElementsByTagNameNS(String namespaceURI,
String localName) Equivalent to 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()
Description copied from interface: Node
Returns whether this node (if it is an element) has any attributes.
hasAttributes in interface Node
true if this node has any attributes, false otherwise.public boolean hasAttribute(String name)
Description copied from interface: Element
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.public boolean hasAttributeNS(String namespaceURI,
String localName) Equivalent to 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()
Description copied from interface: NodeList
The number of nodes in the list. The range of valid child node indices is 0 to length-1 inclusive.
public Node item(int index)
Description copied from interface: NodeList
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.
item in interface NodeList
index - Index into the collection.indexth position in the NodeList, or null if that is not a valid index.public Object getUserObject()
Returns the Object value associated with this node.
Object.setUserObject(java.lang.Object)public void setUserObject(Object userObject)
Sets the value associated with this node.
userObject - the user Object.getUserObject()public void setIdAttribute(String name,
boolean isId)
throws DOMException This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
getSchemaTypeInfo in interface Element
DOMException - - always.public Object setUserData(String key,
Object data,
UserDataHandler handler)
throws DOMException This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
getTextContent in interface Node
DOMException - - always.public void setTextContent(String textContent)
throws DOMException This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
setTextContent in interface Node
DOMException - - always.public short compareDocumentPosition(Node other)
throws DOMException This DOM Level 3 method is not supported for 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 This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.
getBaseURI in interface Node
DOMException - - always.
© 1993–2017, 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.