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 Object clone()

Clones this node; roughly equivalent to cloneNode(false). Element subclasses must provide a new implementation which invokes this method to handle the basics, and then arranges to clone any element attributes directly. Attribute subclasses must make similar arrangements, ensuring that existing ties to elements are broken by cloning.

Overrides:

clone in interface Object

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 void compact()

Reduces space utilization for this node.

public short compareDocumentPosition(Node other)
            throws DOMException

Specified by:

compareDocumentPosition in interface Node

public final int compareTo(Object other)

DOM nodes have a natural ordering: document order.

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:

NullPointerException - When a null event is passed.

ClassCastException - When the event wasn't provided by the createEvent method, or otherwise isn't a DomEvent.

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()

Specified by:

getBaseURI in interface Node

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)

Specified by:

getFeature in interface Node

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 abstract 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

Specified by:

getTextContent in interface Node

public Object getUserData(String key)

Specified by:

getUserData in interface Node

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)

Specified by:

isDefaultNamespace in interface Node

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

public final boolean isReadonly()

Exposes the internal "readonly" flag. In DOM, children of entities and entity references are readonly, as are the objects associated with DocumentType objets.

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

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 void list(PrintStream out,
                 int indent)

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

public void makeReadonly()

Sets the internal "readonly" flag so this subtree can't be changed. Subclasses need to override this method for any associated content that's not a child node, such as an element's attributes or the (few) declarations associated with a DocumentType.

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

Specified by:

setTextContent in interface Node

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

Specified by:

setUserData in interface Node

public String toString()

Overrides:

toString in interface Object

public void trimToSize()

Minimize extra space consumed by this node to hold children and event listeners.