org.htmlunit.xpath.xml.dtm.ref

Class DTMNodeList

java.lang.Object

org.htmlunit.xpath.xml.dtm.ref.DTMNodeListBase

org.htmlunit.xpath.xml.dtm.ref.DTMNodeList

All Implemented Interfaces:

NodeList

public class DTMNodeList
extends DTMNodeListBase

DTMNodeList gives us an implementation of the DOM's NodeList interface wrapped around a DTM Iterator. The author considers this something of an abominations, since NodeList was not intended to be a general purpose "list of nodes" API and is generally considered by the DOM WG to have be a mistake... but I'm told that some of the XPath/XSLT folks say they must have this solution.

Please note that this is not necessarily equivlaent to a DOM NodeList operating over the same document. In particular:

• If there are several Text nodes in logical succession (ie, across CDATASection and EntityReference boundaries), we will return only the first; the caller is responsible for stepping through them. (%REVIEW% Provide a convenience routine here to assist, pending proposed DOM Level 3 getAdjacentText() operation?)
• Since the whole XPath/XSLT architecture assumes that the source document is not altered while we're working with it, we do not promise to implement the DOM NodeList's "live view" response to document mutation.

State: In progress!!

Constructor Summary

Constructors

Constructor and Description
DTMNodeList(DTMIterator dtmIterator) Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMIterator

Method Summary

Modifier and Type	Method and Description
DTMIterator	getDTMIterator() Access the wrapped DTMIterator.
int	getLength()
Node	item(int index)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DTMNodeList

public DTMNodeList(DTMIterator dtmIterator)

Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMIterator

WARNING: THIS HAS THE SIDE EFFECT OF ISSUING setShouldCacheNodes(true) AGAINST THE DTMIterator.

Parameters:

dtmIterator - the iterator to get the nodes from

Method Detail

getDTMIterator

public DTMIterator getDTMIterator()

Access the wrapped DTMIterator. I'm not sure whether anyone will need this or not, but let's write it and think about it.

Returns:

the wrapped DTMIterator

item

public Node item(int index)

Specified by:

item in interface NodeList

Overrides:

item in class DTMNodeListBase

getLength

public int getLength()

Specified by:

getLength in interface NodeList

Overrides:

getLength in class DTMNodeListBase