Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface Node
Node
interface is the primary datatype for the entire
Document Object Model. It represents a single node in the document tree.
While all objects implementing the Node
interface expose
methods for dealing with children, not all objects implementing the
Node
interface may have children. For example,
Text
nodes may not have children, and adding children to
such nodes results in a DOMException
being raised.
The attributes nodeName
, nodeValue
and
attributes
are included as a mechanism to get at node
information without casting down to the specific derived interface. In
cases where there is no obvious mapping of these attributes for a
specific nodeType
(e.g., nodeValue
for an
Element
or attributes
for a Comment
), this returns null
. Note that the specialized interfaces
may contain additional and more convenient mechanisms to get and set the
relevant information.
See also the Document Object Model (DOM) Level 2 Core Specification.
Field Summary | |
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
static short |
|
Method Summary | |
Node |
|
Node |
|
NamedNodeMap |
|
NodeList |
|
Node |
|
Node |
|
String |
|
String |
|
Node |
|
String |
|
short |
|
String |
|
Document |
|
Node |
|
String |
|
Node |
|
boolean |
|
boolean |
|
Node |
|
boolean |
|
void |
|
Node |
|
Node |
|
void |
|
void |
|
public static final short ATTRIBUTE_NODE
The node is anAttr
.
- Field Value:
- 2
public static final short CDATA_SECTION_NODE
The node is aCDATASection
.
- Field Value:
- 4
public static final short COMMENT_NODE
The node is aComment
.
- Field Value:
- 8
public static final short DOCUMENT_FRAGMENT_NODE
The node is aDocumentFragment
.
- Field Value:
- 11
public static final short DOCUMENT_NODE
The node is aDocument
.
- Field Value:
- 9
public static final short DOCUMENT_TYPE_NODE
The node is aDocumentType
.
- Field Value:
- 10
public static final short ELEMENT_NODE
The node is anElement
.
- Field Value:
- 1
public static final short ENTITY_NODE
The node is anEntity
.
- Field Value:
- 6
public static final short ENTITY_REFERENCE_NODE
The node is anEntityReference
.
- Field Value:
- 5
public static final short NOTATION_NODE
The node is aNotation
.
- Field Value:
- 12
public static final short PROCESSING_INSTRUCTION_NODE
The node is aProcessingInstruction
.
- Field Value:
- 7
public static final short TEXT_NODE
The node is aText
node.
- Field Value:
- 3
public Node appendChild(Node newChild) throws DOMException
Adds the nodenewChild
to the end of the list of children of this node. If thenewChild
is already in the tree, it is first removed.
- Parameters:
newChild
- The node to add.If it is aDocumentFragment
object, the entire contents of the document fragment are moved into the child list of this node
- Returns:
- The node added.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to append is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; (parentNode
isnull
.).
Cloning anElement
copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a childText
node. Cloning anAttribute
directly, as opposed to be cloned as part of anElement
cloning operation, returns a specified attribute (specified
istrue
). Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of anEntityReference
clone are readonly . In addition, clones of unspecifiedAttr
nodes are specified. And, cloningDocument
,DocumentType
,Entity
, andNotation
nodes is implementation dependent.
- Parameters:
deep
- Iftrue
, recursively clone the subtree under the specified node; iffalse
, clone only the node itself (and its attributes, if it is anElement
).
- Returns:
- The duplicate node.
public NamedNodeMap getAttributes()
ANamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.
public NodeList getChildNodes()
ANodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes.
public Node getFirstChild()
The first child of this node. If there is no such node, this returnsnull
.
public Node getLastChild()
The last child of this node. If there is no such node, this returnsnull
.
public String getLocalName()
Returns the local part of the qualified name of this node.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.
- Since:
- DOM Level 2
public String getNamespaceURI()
The namespace URI of this node, ornull
if it is unspecified.
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 thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.Per the Namespaces in XML Specification 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.
- Since:
- DOM Level 2
public Node getNextSibling()
The node immediately following this node. If there is no such node, this returnsnull
.
public String getNodeName()
The name of this node, depending on its type; see the table above.
public short getNodeType()
A code representing the type of the underlying object, as defined above.
public String getNodeValue() throws DOMException
The value of this node, depending on its type; see the table above. When it is defined to benull
, setting it has no effect.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
public Document getOwnerDocument()
TheDocument
object associated with this node. This is also theDocument
object used to create new nodes. When this node is aDocument
or aDocumentType
which is not used with anyDocument
yet, this isnull
.Version: DOM Level 2
public Node getParentNode()
The parent of this node. All nodes, exceptAttr
,Document
,DocumentFragment
,Entity
, andNotation
may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this isnull
.
public String getPrefix()
The namespace prefix of this node, ornull
if it is unspecified.
Note that setting this attribute, when permitted, changes thenodeName
attribute, which holds the qualified name, as well as thetagName
andname
attributes of theElement
andAttr
interfaces, when applicable.
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 thenamespaceURI
andlocalName
do not change.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.
- Since:
- DOM Level 2
public Node getPreviousSibling()
The node immediately preceding this node. If there is no such node, this returnsnull
.
public boolean hasAttributes()
Returns whether this node (if it is an element) has any attributes.
- Returns:
true
if this node has any attributes,false
otherwise.
- Since:
- DOM Level 2
public boolean hasChildNodes()
Returns whether this node has any children.
- Returns:
true
if this node has any children,false
otherwise.
public Node insertBefore(Node newChild, Node refChild) throws DOMException
Inserts the nodenewChild
before the existing child noderefChild
. IfrefChild
isnull
, insertnewChild
at the end of the list of children.
IfnewChild
is aDocumentFragment
object, all of its children are inserted, in the same order, beforerefChild
. If thenewChild
is already in the tree, it is first removed.
- Parameters:
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the new node must be inserted.
- Returns:
- The node being inserted.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to insert is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised ifrefChild
is not a child of this node.
public boolean isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
- Parameters:
feature
- The name of the feature to test. This is the same name which can be passed to the methodhasFeature
onDOMImplementation
.version
- This is the version number of the feature 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 returntrue
.
- Returns:
- Returns
true
if the specified feature is supported on this node,false
otherwise.
- Since:
- DOM Level 2
public void normalize()
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
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 containsCDATASections
, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenText
nodes andCDATASection
nodes.Version: DOM Level 2
public Node removeChild(Node oldChild) throws DOMException
Removes the child node indicated byoldChild
from the list of children, and returns it.
- Parameters:
oldChild
- The node being removed.
- Returns:
- The node removed.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
Replaces the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.
IfnewChild
is aDocumentFragment
object,oldChild
is replaced by all of theDocumentFragment
children, which are inserted in the same order. If thenewChild
is already in the tree, it is first removed.
- Parameters:
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.
- Returns:
- The node replaced.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to put in is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.