public abstract class NodeImpl extends Object implements Node, NodeList, EventTarget, Cloneable
The Node interface provides shared behaviors such as siblings and children, both for consistancy and so that the most common tree operations may be performed without constantly having to downcast to specific node types. When there is no obvious mapping for one of these queries, it will respond with null. Note that the default behavior is that children are forbidden. To permit them, the subclass ParentNode overrides several methods.
NodeImpl also implements NodeList, so it can return itself in response to the getChildNodes() query. This eliminiates the need for a separate ChildNodeList object. Note that this is an IMPLEMENTATION DETAIL; applications should _never_ assume that this identity exists.
All nodes in a single document must originate in that document. (Note that this is much tighter than "must be same implementation") Nodes are all aware of their ownerDocument, and attempts to mismatch will throw WRONG_DOCUMENT_ERR.
However, to save memory not all nodes always have a direct reference to their ownerDocument. When a node is owned by another node it relies on its owner to store its ownerDocument. Parent nodes always store it though, so there is never more than one level of indirection. And when a node doesn't have an owner, ownerNode refers to its ownerDocument.
This class doesn't directly support mutation events, however, it still implements the EventTarget interface and forward all related calls to the document so that the document class do so.
| Modifier and Type | Field and Description |
|---|---|
static short |
DOCUMENT_POSITION_CONTAINS |
static short |
DOCUMENT_POSITION_DISCONNECTED |
static short |
DOCUMENT_POSITION_FOLLOWING |
static short |
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC |
static short |
DOCUMENT_POSITION_IS_CONTAINED |
static short |
DOCUMENT_POSITION_PRECEDING |
protected static int |
FIRSTCHILD |
protected static int |
HASSTRING |
protected static int |
ID |
protected static int |
NORMALIZED |
protected static int |
OWNED |
protected NodeImpl |
ownerNode_ |
protected static int |
READONLY |
protected static int |
SPECIFIED |
protected static int |
SYNCCHILDREN |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE| Modifier | Constructor and Description |
|---|---|
protected |
NodeImpl(CoreDocumentImpl ownerDocument)
No public constructor; only subclasses of Node should be instantiated, and
those normally via a Document's factory methods
Every Node knows what Document it belongs to.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addEventListener(String type,
EventListener listener,
boolean useCapture) |
Node |
appendChild(Node newChild)
Adds a child node to the end of the list of children for this node.
|
protected void |
changed()
Denotes that this node has changed.
|
protected int |
changes() |
Node |
cloneNode(boolean deep)
Returns a duplicate of a given node.
|
short |
compareDocumentPosition(Node other)
Compares a node with this node with regard to their position in the document.
|
boolean |
dispatchEvent(Event event) |
NamedNodeMap |
getAttributes()
Return the collection of attributes associated with this node, or null if
none.
|
String |
getBaseURI()
The absolute base URI of this node or
null if undefined. |
NodeList |
getChildNodes()
Obtain a NodeList enumerating all children of this node.
|
Object |
getFeature(String feature,
String version) |
Node |
getFirstChild()
The first child of this Node, or null if none.
|
Node |
getLastChild()
The first child of this Node, or null if none.
|
int |
getLength()
NodeList method: Count the immediate children of this node
By default we do not have any children, ParentNode overrides this.
|
String |
getLocalName()
Introduced in DOM Level 2.
|
String |
getNamespaceURI()
Introduced in DOM Level 2.
|
Node |
getNextSibling()
The next child of this node's parent, or null if none
|
abstract String |
getNodeName()
the name of this node.
|
protected int |
getNodeNumber() |
abstract short |
getNodeType()
A short integer indicating what type of node this is.
|
String |
getNodeValue()
Returns the node value.
|
Document |
getOwnerDocument()
Find the Document that this Node belongs to (the document in whose context
the Node was created).
|
Node |
getParentNode()
Obtain the DOM-tree parent of this node, or null if it is not currently
active in the DOM tree (perhaps because it has just been created or removed).
|
String |
getPrefix()
Introduced in DOM Level 2.
|
Node |
getPreviousSibling()
The previous child of this node's parent, or null if none
|
String |
getTextContent()
This attribute returns the text content of this node and its descendants.
|
Object |
getUserData(String key)
Retrieves the object associated to a key on a this node.
|
boolean |
hasAttributes()
Returns whether this node (if it is an element) has any attributes.
|
boolean |
hasChildNodes()
Test whether this node has any children.
|
Node |
insertBefore(Node newChild,
Node refChild)
Move one or more node(s) to our list of children.
|
boolean |
isDefaultNamespace(String namespaceURI)
DOM Level 3: Experimental This method checks if the specified
namespaceURI is the default namespace or not. |
boolean |
isEqualNode(Node arg)
Tests whether two nodes are equal.
|
boolean |
isSameNode(Node other)
Returns whether this node is the same node as the given one.
|
boolean |
isSupported(String feature,
String version)
Introduced in DOM Level 2.
|
Node |
item(int index)
NodeList method: Return the Nth immediate child of this node,
or null if the index is out of bounds.
|
String |
lookupNamespaceURI(String specifiedPrefix)
DOM Level 3 - Experimental: Look up the namespace URI associated to the given
prefix, starting from this node.
|
String |
lookupPrefix(String namespaceURI)
DOM Level 3 - Experimental: Look up the prefix associated to the given
namespace URI, starting from this node.
|
void |
needsSyncChildren(boolean value) |
void |
normalize()
Puts all
Text nodes in the full depth of the sub-tree underneath
this Node, including attribute nodes, into a "normal" form where
only markup (e.g., tags, comments, processing instructions, CDATA sections,
and entity references) separates Text nodes, i.e., there are no
adjacent Text nodes. |
Node |
removeChild(Node oldChild)
Remove a child from this Node.
|
void |
removeEventListener(String type,
EventListener listener,
boolean useCapture) |
Node |
replaceChild(Node newChild,
Node oldChild)
Make newChild occupy the location that oldChild used to have.
|
void |
setNodeValue(String x)
Sets the node value.
|
protected void |
setOwnerDocument(CoreDocumentImpl doc) |
void |
setPrefix(String prefix)
Introduced in DOM Level 2.
|
void |
setTextContent(String textContent)
This attribute returns the text content of this node and its descendants.
|
Object |
setUserData(String key,
Object data,
UserDataHandler handler)
Associate an object to a key on this node.
|
String |
toString() |
public static final short DOCUMENT_POSITION_DISCONNECTED
public static final short DOCUMENT_POSITION_PRECEDING
public static final short DOCUMENT_POSITION_FOLLOWING
public static final short DOCUMENT_POSITION_CONTAINS
public static final short DOCUMENT_POSITION_IS_CONTAINED
public static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
protected NodeImpl ownerNode_
protected static final int READONLY
protected static final int SYNCCHILDREN
protected static final int OWNED
protected static final int FIRSTCHILD
protected static final int SPECIFIED
protected static final int HASSTRING
protected static final int NORMALIZED
protected static final int ID
protected NodeImpl(CoreDocumentImpl ownerDocument)
Every Node knows what Document it belongs to.
ownerDocument - the owner documentpublic abstract short getNodeType()
getNodeType in interface Nodepublic abstract String getNodeName()
getNodeName in interface Nodepublic String getNodeValue() throws DOMException
getNodeValue in interface NodeDOMException - DOMSTRING_SIZE_ERRpublic void setNodeValue(String x) throws DOMException
setNodeValue in interface NodeDOMException - NO_MODIFICATION_ALLOWED_ERRpublic Node appendChild(Node newChild) throws DOMException
appendChild in interface NodeDOMException - HIERARCHY_REQUEST_ERR if newChild is of a type that
shouldn't be a child of this node.DOMException - WRONG_DOCUMENT_ERR if newChild has a different owner
document than we do.DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.
By default we do not accept any children, ParentNode overrides this.
,
ParentNodepublic Node cloneNode(boolean deep)
Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior.
cloneNode in interface Node
Example: Cloning a Text node will copy both the node and the text it
contains.
Example: Cloning something that has children -- Element or Attr, for
example -- will _not_ clone those children unless a "deep clone" has
been requested. A shallow clone of an Attr node will yield an empty Attr
of the same name.
NOTE: Clones will always be read/write, even if the node being cloned is
read-only, to permit applications using only the DOM API to obtain
editable copies of locked portions of the tree.
public Document getOwnerDocument()
getOwnerDocument in interface Nodeprotected void setOwnerDocument(CoreDocumentImpl doc)
protected int getNodeNumber()
public Node getParentNode()
getParentNode in interface Nodepublic Node getNextSibling()
getNextSibling in interface Nodepublic Node getPreviousSibling()
getPreviousSibling in interface Nodepublic NamedNodeMap getAttributes()
getAttributes in interface NodeElementImplpublic boolean hasAttributes()
hasAttributes in interface Nodetrue if this node has any attributes, false
otherwise.ElementImplpublic boolean hasChildNodes()
By default we do not have any children, ParentNode overrides this.
hasChildNodes in interface NodeParentNodepublic NodeList getChildNodes()
NodeLists are "live"; as children are added/removed the NodeList will immediately reflect those changes. Also, the NodeList refers to the actual nodes, so changes to those nodes made via the DOM tree will be reflected in the NodeList and vice versa.
In this implementation, Nodes implement the NodeList interface and provide their own getChildNodes() support. Other DOMs may solve this differently.
getChildNodes in interface Nodepublic Node getFirstChild()
By default we do not have any children, ParentNode overrides this.
getFirstChild in interface NodeParentNodepublic Node getLastChild()
By default we do not have any children, ParentNode overrides this.
getLastChild in interface NodeParentNodepublic Node insertBefore(Node newChild, Node refChild) throws DOMException
By default we do not accept any children, ParentNode overrides this.
insertBefore in interface NodenewChild - The Node to be moved to our subtree. As a convenience
feature, inserting a DocumentNode will instead insert all its
children.refChild - Current child which newChild should be placed immediately
before. If refChild is null, the insertion occurs after all
existing Nodes, like appendChild().DOMException - HIERARCHY_REQUEST_ERR if newChild is of a type that
shouldn't be a child of this node, or if newChild is an
ancestor of this node.DOMException - WRONG_DOCUMENT_ERR if newChild has a different owner
document than we do.DOMException - NOT_FOUND_ERR if refChild is not a child of this node.DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.ParentNodepublic Node removeChild(Node oldChild) throws DOMException
By default we do not have any children, ParentNode overrides this.
removeChild in interface NodeDOMException - NOT_FOUND_ERR if oldChild is not a child of this node.DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.ParentNodepublic Node replaceChild(Node newChild, Node oldChild) throws DOMException
By default we do not have any children, ParentNode overrides this.
replaceChild in interface NodeDOMException - HIERARCHY_REQUEST_ERR if newChild is of a type that
shouldn't be a child of this node, or if newChild is one
of our ancestors.DOMException - WRONG_DOCUMENT_ERR if newChild has a different owner
document than we do.DOMException - NOT_FOUND_ERR if oldChild is not a child of this node.DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.ParentNodepublic int getLength()
By default we do not have any children, ParentNode overrides this.
public Node item(int index)
By default we do not have any children, ParentNode overrides this.
public void normalize()
Text nodes in the full depth of the sub-tree underneath
this Node, including attribute nodes, into a "normal" form where
only markup (e.g., tags, comments, processing instructions, CDATA sections,
and entity references) separates Text nodes, i.e., there are no
adjacent Text nodes. This can be used to ensure that the DOM
view of a document is the same as if it were saved and re-loaded, and is
useful when operations (such as XPointer lookups) that depend on a particular
document tree structure are to be used.In cases where the document contains
CDATASections, the normalize operation alone may not be
sufficient, since XPointers do not differentiate between Text
nodes and CDATASection nodes.
Note that this implementation simply calls normalize() on this Node's children. It is up to implementors or Node to override normalize() to take action.
public boolean isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
isSupported in interface Nodefeature - The package name of the feature to test. This is the same name
as what can be passed to the method hasFeature on
DOMImplementation.version - This is the version number of the package name to test. In
Level 2, version 1, this is the string "2.0". If the version
is not specified, supporting any version of the feature will
cause the method to return true.public String getNamespaceURI()
The namespace URI of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE, this is always null and setting it has no effect.
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 created with a DOM Level 1 method, such as createElement from the Document interface, this is null.
getNamespaceURI in interface NodeAttrNSImpl,
ElementNSImplpublic String getPrefix()
The namespace prefix of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is always null and setting it has no effect.
For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.
getPrefix in interface NodeAttrNSImpl,
ElementNSImplpublic void setPrefix(String prefix) throws DOMException
The namespace prefix of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is always null and setting it has no effect.
For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.
Note that setting this attribute 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.
setPrefix in interface NodeDOMException - INVALID_CHARACTER_ERR Raised if the specified prefix
contains an invalid character.AttrNSImpl,
ElementNSImplpublic String getLocalName()
Returns the local part of the qualified name of this node. For nodes created with a DOM Level 1 method, such as createElement from the Document interface, and for nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is the same as the nodeName attribute.
getLocalName in interface NodeAttrNSImpl,
ElementNSImplpublic void addEventListener(String type, EventListener listener, boolean useCapture)
addEventListener in interface EventTargetpublic void removeEventListener(String type, EventListener listener, boolean useCapture)
removeEventListener in interface EventTargetpublic boolean dispatchEvent(Event event)
dispatchEvent in interface EventTargetpublic String getBaseURI()
null if undefined. This
value is computed according to . However, when the Document
supports the feature "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. Element, a Document or a a
ProcessingInstruction, this attribute represents the properties
[base URI] defined in . When the node is a Notation, an
Entity, or an EntityReference, this attribute
represents the properties [declaration base URI] in the . How will this be
affected by resolution of relative namespace URIs issue?It's not.Should this
only be on Document, Element, ProcessingInstruction, Entity, and Notation
nodes, according to the infoset? If not, what is it equal to on other nodes?
Null? An empty string? I think it should be the parent's.No.Should this be
read-only and computed or and actual read-write attribute?Read-only and
computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML
element is not yet attached to a document, does the insert change the
Document.baseURI? Yes. (F2F 26 Sep 2001)getBaseURI in interface Nodepublic short compareDocumentPosition(Node other) throws DOMException
compareDocumentPosition in interface Nodeother - The node to compare against this node.DOMExceptionpublic String getTextContent() throws DOMException
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, the returned string
does not contain the element content whitespaces . Similarly, on setting, no
parsing is performed either, the input string is taken as pure textual
content. | Node type | Content |
|---|---|
| ELEMENT_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 |
| ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
getTextContent in interface NodeDOMException - DOMSTRING_SIZE_ERR: Raised when it would return more
characters than fit in a DOMString
variable on the implementation platform.public void setTextContent(String textContent) throws DOMException
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, the returned string
does not contain the element content whitespaces . Similarly, on setting, no
parsing is performed either, the input string is taken as pure textual
content. | Node type | Content |
|---|---|
| ELEMENT_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 |
| ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
setTextContent in interface NodeDOMException - DOMSTRING_SIZE_ERR: Raised when it would return more
characters than fit in a DOMString
variable on the implementation platform.public boolean isSameNode(Node other)
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 interchangably, such
that all attributes have the same values and calling the same DOM method on
either reference always has exactly the same effect.isSameNode in interface Nodeother - The node to test against.true if the nodes are the same,
false otherwise.public boolean isDefaultNamespace(String namespaceURI)
namespaceURI is the default namespace or not.isDefaultNamespace in interface NodenamespaceURI - The namespace URI to look for.true if the specified namespaceURI is the
default namespace, false otherwise.public String lookupPrefix(String namespaceURI)
lookupPrefix in interface NodenamespaceURI - the namespace uripublic String lookupNamespaceURI(String specifiedPrefix)
lookupNamespaceURI in interface Nodepublic boolean isEqualNode(Node arg)
Node.isSameNode. All nodes that are the same will also be equal,
though the reverse may not be true. nodeName, localName, namespaceURI,
prefix, nodeValue , baseURI. 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. This
is true for Attr nodes as for any other type of node. Note that
normalization can affect equality; to avoid this, nodes should be normalized
before being compared. 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. ownerDocument attribute, the specified attribute
for Attr nodes, the isWhitespaceInElementContent
attribute for Text nodes, as well as any user data or event
listeners registered on the nodes.isEqualNode in interface Nodearg - The node to compare equality with.true
otherwise false.public Object getFeature(String feature, String version)
getFeature in interface Nodepublic Object setUserData(String key, Object data, UserDataHandler handler)
getUserData with the same key.setUserData in interface Nodekey - 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.DOMObject previously associated to the given
key on this node, or null if there was none.public Object getUserData(String key)
setUserData with the
same key.getUserData in interface Nodekey - The key the object is associated to.DOMObject associated to the given key on
this node, or null if there was none.protected void changed()
protected int changes()
public final void needsSyncChildren(boolean value)
Copyright © 2024 HtmlUnit. All rights reserved.