Package org.apache.harmony.xml.dom

Class ElementImpl

java.lang.Object
org.apache.harmony.xml.dom.NodeImpl
org.apache.harmony.xml.dom.LeafNodeImpl
org.apache.harmony.xml.dom.InnerNodeImpl
org.apache.harmony.xml.dom.ElementImpl
All Implemented Interfaces:
Element, Node
public class ElementImpl
extends InnerNodeImpl
implements Element
Provides a straightforward implementation of the corresponding W3C DOM interface. The class is used internally only, thus only notable members that are not in the original interface are documented (the W3C docs are quite extensive). Hope that's ok.

Some of the fields may have package visibility, so other classes belonging to the DOM implementation can easily access them while maintaining the DOM tree structure.

  • Method Details

    • getAttribute

      public String getAttribute​(String name)
      Description copied from interface: Element
      Retrieves an attribute value by name.
      Specified by:
      getAttribute in interface Element
      Parameters:
      name - The name of the attribute to retrieve.
      Returns:
      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)
      Description copied from interface: Element
      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.
      Specified by:
      getAttributeNS in interface Element
      Parameters:
      namespaceURI - The namespace URI of the attribute to retrieve.
      localName - The local name of the attribute to retrieve.
      Returns:
      The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

    • getAttributeNode

      public AttrImpl 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.
      Specified by:
      getAttributeNode in interface Element
      Parameters:
      name - The name (nodeName) of the attribute to retrieve.
      Returns:
      The Attr node with the specified name ( nodeName) or null if there is no such attribute.

    • getAttributeNodeNS

      public AttrImpl getAttributeNodeNS​(String namespaceURI, String localName)
      Description copied from interface: Element
      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.
      Specified by:
      getAttributeNodeNS in interface Element
      Parameters:
      namespaceURI - The namespace URI of the attribute to retrieve.
      localName - The local name of the attribute to retrieve.
      Returns:
      The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

    • getAttributes

      public NamedNodeMap getAttributes()
      Description copied from interface: Node
      A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
      Specified by:
      getAttributes in interface Node
      Overrides:
      getAttributes in class NodeImpl

    • getElementsByTagName

      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.
      Specified by:
      getElementsByTagName in interface Element
      Parameters:
      name - The name of the tag to match on. The special value "*" matches all tags.
      Returns:
      A list of matching Element nodes.

    • getElementsByTagNameNS

      public NodeList getElementsByTagNameNS​(String namespaceURI, String localName)
      Description copied from interface: Element
      Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.
      Specified by:
      getElementsByTagNameNS in interface Element
      Parameters:
      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.
      Returns:
      A new NodeList object containing all the matched Elements.

    • getLocalName

      public String getLocalName()
      Description copied from interface: Node
      Returns the local part of the qualified name of this node.
      For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.
      Specified by:
      getLocalName in interface Node
      Overrides:
      getLocalName in class NodeImpl

    • getNamespaceURI

      public String getNamespaceURI()
      Description copied from interface: Node
      The namespace URI of this node, or null if it is unspecified (see ).
      This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
      For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.

      Note: Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

      Specified by:
      getNamespaceURI in interface Node
      Overrides:
      getNamespaceURI in class NodeImpl

    • getNodeName

      public String getNodeName()
      Description copied from interface: Node
      The name of this node, depending on its type; see the table above.
      Specified by:
      getNodeName in interface Node
      Overrides:
      getNodeName in class NodeImpl

    • getNodeType

      public short getNodeType()
      Description copied from interface: Node
      A code representing the type of the underlying object, as defined above.
      Specified by:
      getNodeType in interface Node
      Specified by:
      getNodeType in class NodeImpl

    • getPrefix

      public String getPrefix()
      Description copied from interface: Node
      The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
      Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
      Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
      Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
      For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.
      Specified by:
      getPrefix in interface Node
      Overrides:
      getPrefix in class NodeImpl

    • getTagName

      public String getTagName()
      Description copied from interface: Element
      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.
      Specified by:
      getTagName in interface Element

    • hasAttribute

      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.
      Specified by:
      hasAttribute in interface Element
      Parameters:
      name - The name of the attribute to look for.
      Returns:
      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)
      Description copied from interface: Element
      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.
      Specified by:
      hasAttributeNS in interface Element
      Parameters:
      namespaceURI - The namespace URI of the attribute to look for.
      localName - The local name of the attribute to look for.
      Returns:
      true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

    • hasAttributes

      public boolean hasAttributes()
      Description copied from interface: Node
      Returns whether this node (if it is an element) has any attributes.
      Specified by:
      hasAttributes in interface Node
      Overrides:
      hasAttributes in class NodeImpl
      Returns:
      Returns true if this node has any attributes, false otherwise.

    • removeAttribute

      public void removeAttribute​(String name) throws DOMException
      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.
      Specified by:
      removeAttribute in interface Element
      Parameters:
      name - The name of the attribute to remove.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

    • removeAttributeNS

      public void removeAttributeNS​(String namespaceURI, String localName) throws DOMException
      Description copied from interface: Element
      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.
      Specified by:
      removeAttributeNS in interface Element
      Parameters:
      namespaceURI - The namespace URI of the attribute to remove.
      localName - The local name of the attribute to remove.
      Throws:
      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) throws DOMException
      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.
      Specified by:
      removeAttributeNode in interface Element
      Parameters:
      oldAttr - The Attr node to remove from the attribute list.
      Returns:
      The Attr node that was removed.
      Throws:
      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) throws DOMException
      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.
      Specified by:
      setAttribute in interface Element
      Parameters:
      name - The name of the attribute to create or alter.
      value - Value to set in string form.
      Throws:
      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) throws DOMException
      Description copied from interface: Element
      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.
      Specified by:
      setAttributeNS in interface Element
      Parameters:
      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.
      Throws:
      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) 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.
      Specified by:
      setAttributeNode in interface Element
      Parameters:
      newAttr - The Attr node to add to the attribute list.
      Returns:
      If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.
      Throws:
      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) throws DOMException
      Description copied from interface: Element
      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.
      Specified by:
      setAttributeNodeNS in interface Element
      Parameters:
      newAttr - The Attr node to add to the attribute list.
      Returns:
      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.
      Throws:
      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]).

    • setPrefix

      public void setPrefix​(String prefix)
      Description copied from interface: Node
      The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
      Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
      Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
      Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
      For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.
      Specified by:
      setPrefix in interface Node
      Overrides:
      setPrefix in class NodeImpl

    • getSchemaTypeInfo

      public TypeInfo getSchemaTypeInfo()
      Description copied from interface: Element
      The type information associated with this element.
      Specified by:
      getSchemaTypeInfo in interface Element

    • setIdAttribute

      public void setIdAttribute​(String name, boolean isId) throws DOMException
      Description copied from interface: Element
      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.
      Specified by:
      setIdAttribute in interface Element
      Parameters:
      name - The name of the attribute.
      isId - Whether the attribute is a of type ID.
      Throws:
      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
      Description copied from interface: Element
      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.
      Specified by:
      setIdAttributeNS in interface Element
      Parameters:
      namespaceURI - The namespace URI of the attribute.
      localName - The local name of the attribute.
      isId - Whether the attribute is a of type ID.
      Throws:
      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
      Description copied from interface: Element
      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.
      Specified by:
      setIdAttributeNode in interface Element
      Parameters:
      idAttr - The attribute node.
      isId - Whether the attribute is a of type ID.
      Throws:
      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.