com.aspose.words

Class NodeList

java.lang.Object

com.aspose.words.NodeList

All Implemented Interfaces:

java.lang.Iterable

public class NodeList
extends java.lang.Object
implements java.lang.Iterable

Represents a collection of nodes matching an XPath query executed using the CompositeNode.selectNodes(java.lang.String) method.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

NodeList is returned by CompositeNode.selectNodes(java.lang.String) and contains a collection of nodes matching the XPath query.

NodeList supports indexed access and iteration.

Treat the NodeList collection as a "snapshot" collection. NodeList starts as a "live" collection because the nodes are not actually retrieved when the XPath query is run. The nodes are only retrieved upon access and at this time the node and all nodes that precede it are cached forming a "snapshot" collection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeList(java.util.List nodeList) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
Node	get(int index) Retrieves a node at the given index.
int	getCount() Gets the number of nodes in the list.
java.util.Iterator	iterator() Provides a simple "foreach" style iteration over the collection of nodes.
Node[]	toArray() Copies all nodes from the collection to a new array of nodes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

NodeList

protected NodeList(java.util.List nodeList)

Initializes a new instance of this class.

Method Detail

get

public Node get(int index)

Retrieves a node at the given index.

The index is zero-based.

Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.

If index is greater than or equal to the number of items in the list, this returns a null reference.

If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.

Parameters:

index - An index into the list of nodes.

Returns:

The corresponding Node value.

getCount

public int getCount()

Gets the number of nodes in the list.

Returns:

The number of nodes in the list.

toArray

public Node[] toArray()

Copies all nodes from the collection to a new array of nodes.

You should not be adding/removing nodes while iterating over a collection of nodes because it invalidates the iterator and requires refreshes for live collections.

To be able to add/remove nodes during iteration, use this method to copy nodes into a fixed-size array and then iterate over the array.

Returns:

An array of nodes.

iterator

public java.util.Iterator iterator()

Provides a simple "foreach" style iteration over the collection of nodes.

Specified by:

iterator in interface java.lang.Iterable

Returns:

An Iterator.