Class DomNode

protected DomNode(short nodeType,
                  DomDocument owner)

Constructs a node and associates it with its owner. Only Document and DocumentType nodes may be created with no owner, and DocumentType nodes get an owner as soon as they are associated with a document.

public final void addEventListener(String type,
                                   EventListener listener,
                                   boolean useCapture)

DOM L2 (Events) Registers an event listener's interest in a class of events.

Specified by:

addEventListener in interface EventTarget

public Node appendChild(Node newChild)

DOM L1 Appends the specified node to this node's list of children. Document subclasses must override this to enforce the restrictions that there be only one element and document type child.

Causes a DOMNodeInserted mutation event to be reported. Will first cause a DOMNodeRemoved event to be reported if the parameter already has a parent. If the new child is a document fragment node, both events will be reported for each child of the fragment; the order in which children are removed and inserted is implementation-specific.

If this DOM has been compiled without mutation event support, these events will not be reported.

Specified by:

appendChild in interface Node

public Node cloneNode(boolean deep)

DOM L1 Returns a clone of this node which optionally includes cloned versions of child nodes. Clones are always mutable, except for entity reference nodes.

Specified by:

cloneNode in interface Node

public short compareDocumentPosition(Node other)
            throws DOMException

Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.

Specified by:

compareDocumentPosition in interface Node

Parameters:

other - The node to compare against the reference node.

Returns:

Returns how the node is positioned relatively to the reference node.

Throws:

DOMException - NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.

Since:

DOM Level 3

public Event createEvent(String eventType)

DOM L2 (Events) Returns an instance of the specified type of event object. Understands about DOM Mutation, HTML, and UI events.

If the name of the event type begins with "USER-", then an object implementing the "Event" class will be returned; this provides a limited facility for application-defined events to use the DOM event infrastructure. Alternatively, use one of the standard DOM event classes and initialize it using use such a "USER-" event type name; or defin, instantiate, and initialize an application-specific subclass of DomEvent and pass that to dispatchEvent().

Specified by:

createEvent in interface DocumentEvent

Parameters:

eventType - Identifies the particular DOM feature module defining the type of event, such as "MutationEvents". The event "name" is a different kind of "type".

public final boolean dispatchEvent(Event event)
            throws EventException

DOM L2 (Events) Delivers an event to all relevant listeners, returning true if the caller should perform their default action. Note that the event must have been provided by the createEvent() method on this class, else it can't be dispatched.

Specified by:

dispatchEvent in interface EventTarget

Throws:

EventException - If the event type wasn't specified

See Also:

createEvent(String)

public NamedNodeMap getAttributes()

DOM L1 Returns null; Element subclasses must override this method.

Specified by:

getAttributes in interface Node

public String getBaseURI()

The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when the Document supports the feature "HTML" [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.

Specified by:

getBaseURI in interface Node

Since:

DOM Level 3

public NodeList getChildNodes()

DOM L1 Returns a list, possibly empty, of the children of this node. In this implementation, to conserve memory, nodes are the same as their list of children. This can have ramifications for subclasses, which may need to provide their own getLength method for reasons unrelated to the NodeList method of the same name.

Specified by:

getChildNodes in interface Node

public NodeList getElementsByTagName(String tag)

DOM L1 Creates a NodeList giving array-style access to elements with the specified name. Access is fastest if indices change by small values, and the DOM is not modified.

public NodeList getElementsByTagNameNS(String namespace,
                                       String local)

DOM L2 Creates a NodeList giving array-style access to elements with the specified namespace and local name. Access is fastest if indices change by small values, and the DOM is not modified.

public Object getFeature(String feature,
                         String version)

This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support the Node interface.

Specified by:

getFeature in interface Node

Parameters:

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.

Returns:

Returns an object which implements the specialized APIs of the specified feature and version, if any, or 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.

Since:

DOM Level 3

public Node getFirstChild()

DOM L1 Returns the first child of this node, or null if there are none.

Specified by:

getFirstChild in interface Node

public Node getLastChild()

DOM L1 Returns the last child of this node, or null if there are none.

Specified by:

getLastChild in interface Node

public int getLength()

DOM L1 (NodeList) Returns the number of elements in this NodeList. (Note that many interfaces have a "Length" property, not just NodeList, and if a node subtype must implement one of those, it will also need to override getChildNodes.)

Specified by:

getLength in interface NodeList

public String getLocalName()

DOM L2 Returns the node name; this must be overridden for element and attribute nodes.

Specified by:

getLocalName in interface Node

public String getNamespaceURI()

DOM L2 Returns null; this must be overridden for element and attribute nodes.

Specified by:

getNamespaceURI in interface Node

public Node getNextSibling()

DOM L1 Returns the previous sibling, if one is known.

Specified by:

getNextSibling in interface Node

public String getNodeName()

This forces GCJ compatibility. Without this method GCJ seems unable to natively compile GNUJAXP.

Specified by:

getNodeName in interface Node

public final short getNodeType()

This forces GCJ compatibility. Without this method GCJ is unable to compile to byte code.

Specified by:

getNodeType in interface Node

public String getNodeValue()

DOM L1 Returns null; this must be overridden for nodes types with a defined value, along with the setNodeValue method.

Specified by:

getNodeValue in interface Node

public final Document getOwnerDocument()

DOM L1 (modified in L2) Returns the owner document. This is only null for Document nodes, and (new in L2) for DocumentType nodes which have not yet been associated with the rest of their document.

Specified by:

getOwnerDocument in interface Node

public Node getParentNode()

DOM L1 Returns the parent node, if one is known.

Specified by:

getParentNode in interface Node

public String getPrefix()

DOM L2 Returns null; this must be overridden for element and attribute nodes.

Specified by:

getPrefix in interface Node

public Node getPreviousSibling()

DOM L1 Returns the previous sibling, if one is known.

Specified by:

getPreviousSibling in interface Node

public final String getTextContent()
            throws DOMException

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:

Node type	Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE	concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE	nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE	null

Specified by:

getTextContent in interface Node

Throws:

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

Since:

DOM Level 3

public Object getUserData(String key)

Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.

Specified by:

getUserData in interface Node

Parameters:

key - The key the object is associated to.

Returns:

Returns the DOMUserData associated to the given key on this node, or null if there was none.

Since:

DOM Level 3

public boolean hasAttributes()

DOM L2> Returns true iff this is an element node with attributes.

Specified by:

hasAttributes in interface Node

public boolean hasChildNodes()

DOM L1 Returns true if this node has children.

Specified by:

hasChildNodes in interface Node

public Node insertBefore(Node newChild,
                         Node refChild)

DOM L1 Inserts the specified node in this node's list of children. Document subclasses must override this to enforce the restrictions that there be only one element and document type child.

Causes a DOMNodeInserted mutation event to be reported. Will first cause a DOMNodeRemoved event to be reported if the newChild parameter already has a parent. If the new child is a document fragment node, both events will be reported for each child of the fragment; the order in which children are removed and inserted is implementation-specific.

If this DOM has been compiled without mutation event support, these events will not be reported.

Specified by:

insertBefore in interface Node

public boolean isDefaultNamespace(String namespaceURI)

This method checks if the specified namespaceURI is the default namespace or not.

Specified by:

isDefaultNamespace in interface Node

Parameters:

namespaceURI - The namespace URI to look for.

Returns:

Returns true if the specified namespaceURI is the default namespace, false otherwise.

Since:

DOM Level 3

public boolean isEqualNode(Node arg)

Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:

• The two nodes are of the same type.
• The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.
• The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.
• The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.

For two DocumentType nodes to be equal, the following conditions must also be satisfied:

• The following string attributes are equal: publicId, systemId, internalSubset.
• The entities NamedNodeMaps are equal.
• The notations NamedNodeMaps are equal.

On the other hand, the following do not affect equality: the ownerDocument, baseURI, and parentNode attributes, the specified attribute for Attr nodes, the schemaTypeInfo attribute for Attr and Element nodes, the Text.isElementContentWhitespace attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.

Specified by:

isEqualNode in interface Node

Parameters:

arg - The node to compare equality with.

Returns:

Returns true if the nodes are equal, false otherwise.

Since:

DOM Level 3

public boolean isSameNode(Node other)

Returns whether this node is the same node as the given one.
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

Specified by:

isSameNode in interface Node

Parameters:

other - The node to test against.

Returns:

Returns true if the nodes are the same, false otherwise.

Since:

DOM Level 3

public boolean isSupported(String feature,
                           String version)

DOM L2 Consults the DOM implementation to determine if the requested feature is supported. DocumentType subclasses must override this method, and associate themselves directly with the DOMImplementation node used. (This method relies on being able to access the DOMImplementation from the owner document, but DocumentType nodes can be created without an owner.)

Specified by:

isSupported in interface Node

public Node item(int index)

DOM L1 (NodeList) Returns the item with the specified index in this NodeList, else null.

Specified by:

item in interface NodeList

public String lookupNamespaceURI(String prefix)

Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.

Specified by:

lookupNamespaceURI in interface Node

Parameters:

prefix - The prefix to look for. If this parameter is null, the method will return the default namespace URI if any.

Returns:

Returns the associated namespace URI or null if none is found.

Since:

DOM Level 3

public String lookupPrefix(String namespaceURI)

Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.

Specified by:

lookupPrefix in interface Node

Parameters:

namespaceURI - The namespace URI to look for.

Returns:

Returns an associated namespace prefix if found or null if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.

Since:

DOM Level 3

public boolean nameAndTypeEquals(Node other)

Returns true iff node types match, and either (a) both nodes have no namespace and their getNodeName() values are the same, or (b) both nodes have the same getNamespaceURI() and same getLocalName() values.

Note that notion of a "Per-Element-Type" attribute name scope, as found in a non-normative appendix of the XML Namespaces specification, is not supported here. Your application must implement that notion, typically by not bothering to check nameAndTypeEquals for attributes without namespace URIs unless you already know their elements are nameAndTypeEquals.

public final void normalize()

DOM L1 (relocated in DOM L2) In this node and all contained nodes (including attributes if relevant) merge adjacent text nodes. This is done while ignoring text which happens to use CDATA delimiters).

Specified by:

normalize in interface Node

public Node removeChild(Node refChild)

DOM L1 Removes the specified child from this node's list of children, or else reports an exception.

Causes a DOMNodeRemoved mutation event to be reported.

If this DOM has been compiled without mutation event support, these events will not be reported.

Specified by:

removeChild in interface Node

public final void removeEventListener(String type,
                                      EventListener listener,
                                      boolean useCapture)

DOM L2 (Events) Unregisters an event listener.

Specified by:

removeEventListener in interface EventTarget

public Node replaceChild(Node newChild,
                         Node refChild)

DOM L1 Replaces the specified node in this node's list of children. Document subclasses must override this to test the restrictions that there be only one element and document type child.

Causes DOMNodeRemoved and DOMNodeInserted mutation event to be reported. Will cause another DOMNodeRemoved event to be reported if the newChild parameter already has a parent. These events may be delivered in any order, except that the event reporting removal from such an existing parent will always be delivered before the event reporting its re-insertion as a child of some other node. The order in which children are removed and inserted is implementation specific.

If your application needs to depend on the in which those removal and insertion events are delivered, don't use this API. Instead, invoke the removeChild and insertBefore methods directly, to guarantee a specific delivery order. Similarly, don't use document fragments, Otherwise your application code may not work on a DOM which implements this method differently.

If this DOM has been compiled without mutation event support, these events will not be reported.

Specified by:

replaceChild in interface Node

public void setNodeValue(String value)

DOM L1 Does nothing; this must be overridden (along with the getNodeValue method) for nodes with a non-null defined value.

Specified by:

setNodeValue in interface Node

public void setPrefix(String prefix)

DOM L2 Does nothing; this must be overridden (along with the getPrefix method) for element and attribute nodes.

Specified by:

setPrefix in interface Node

public void setTextContent(String textContent)
            throws DOMException

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:

Node type	Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE	concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE	nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE	null

Specified by:

setTextContent in interface Node

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Since:

DOM Level 3

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

Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.

Specified by:

setUserData in interface Node

Parameters:

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.

Returns:

Returns the DOMUserData previously associated to the given key on this node, or null if there was none.

Since:

DOM Level 3