NodeCollection (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.NodeCollection

All Implemented Interfaces:

java.lang.Iterable

Direct Known Subclasses:

BuildingBlockCollection, CellCollection, CommentCollection, HeaderFooterCollection, ParagraphCollection, RowCollection, RunCollection, SectionCollection, TableCollection
```
public class NodeCollection
extends java.lang.Object
implements java.lang.Iterable
```
Represents a collection of nodes of a specific type.
To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

NodeCollection does not own the nodes it contains, rather, is just a selection of nodes of the specified type, but the nodes are stored in the tree under their respective parent nodes.

NodeCollection supports indexed access, iteration and provides add and remove methods.

The NodeCollection collection is "live", i.e. changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeCollection properties and methods.

NodeCollection is returned by M:Aspose.Words.CompositeNode.GetChildNodes(Aspose.Words.NodeType,System.Boolean) and also serves as a base class for typed node collections such as SectionCollection, ParagraphCollection etc.

NodeCollection can be "flat" and contain only immediate children of the node it was created from, or it can be "deep" and contain all descendant children.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Node node)` Adds a node to the end of the collection.
`void`	`clear()` Removes all nodes from this collection and from the document.
`boolean`	`contains(Node node)` Determines whether a node is in the collection.
`Node`	`get(int index)` Retrieves a node at the given index.
`CompositeNode`	`getContainer()`
`int`	`getCount()` Gets the number of nodes in the collection.
`Node`	`getCurrentNode()`
`Node`	`getNextMatchingNode(Node curNode)`
`int`	`indexOf(Node node)` Returns the zero-based index of the specified node.
`void`	`insert(int index, Node node)` Inserts a node into the collection at the specified index.
`java.util.Iterator`	`iterator()` Provides a simple "foreach" style iteration over the collection of nodes.
`void`	`remove(Node node)` Removes the node from the collection and from the document.
`void`	`removeAt(int index)` Removes the node at the specified index from the collection and from the document.
`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

- Method Detail
  - get
```
public Node get(int index)
```
    Retrieves a node at the given index.
    
    Parameters:
    
    index - An index into the collection of nodes.
    
    Returns:
    
    The corresponding Node value.
  - add
```
public void add(Node node)
```
    Adds a node to the end of the collection.
    The node is inserted as a child into the node object from which the collection was created.
    
    If the newChild is already in the tree, it is first removed.
    
    If the node being inserted was created from another document, you should use M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) to import the node to the current document. The imported node can then be inserted into the current document.
    
    Parameters:
    
    node - The node to be added to the end of the collection.
    
    Throws:
    
    com.aspose.words.net.System.NotSupportedException - The NodeCollection is a "deep" collection.
  - insert
```
public void insert(int index,
                   Node node)
```
    Inserts a node into the collection at the specified index.
    The node is inserted as a child into the node object from which the collection was created.
    
    If the index is equal to or greater than Count, the node is added at the end of the collection.
    
    If the index is negative and its absolute value is greater than Count, the node is added at the end of the collection.
    
    If the newChild is already in the tree, it is first removed.
    
    If the node being inserted was created from another document, you should use M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) to import the node to the current document. The imported node can then be inserted into the current document.
    
    Parameters:
    
    index - The zero-based index of the node. Negative indexes are allowed and indicate access from the back of the list. For example -1 means the last node, -2 means the second before last and so on.
    
    node - The node to insert.
    
    Throws:
    
    com.aspose.words.net.System.NotSupportedException - The NodeCollection is a "deep" collection.
  - remove
```
public void remove(Node node)
```
    Removes the node from the collection and from the document.
    
    Parameters:
    
    node - The node to remove.
  - removeAt
```
public void removeAt(int index)
```
    Removes the node at the specified index from the collection and from the document.
    
    Parameters:
    
    index - The zero-based index of the node. Negative indexes are allowed and indicate access from the back of the list. For example -1 means the last node, -2 means the second before last and so on.
  - clear
```
public void clear()
```
    Removes all nodes from this collection and from the document.
  - contains
```
public boolean contains(Node node)
```
    Determines whether a node is in the collection.
    This method performs a linear search; therefore, the average execution time is proportional to Count.
    
    Parameters:
    
    node - The node to locate.
    
    Returns:
    
    True if item is found in the collection; otherwise, false.
  - indexOf
```
public int indexOf(Node node)
```
    Returns the zero-based index of the specified node.
    
    Parameters:
    
    node - The node to locate.
    
    Returns:
    
    The zero-based index of the node within the collection, if found; otherwise, -1.
  - 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.
  - getNextMatchingNode
```
public Node getNextMatchingNode(Node curNode)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getCount
```
public int getCount()
```
    Gets the number of nodes in the collection.
    
    Returns:
    
    The number of nodes in the collection.
  - getCurrentNode
```
public Node getCurrentNode()
```
  - getContainer
```
public CompositeNode getContainer()
```

Class NodeCollection

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

get

add

insert

remove

removeAt

clear

contains

indexOf

toArray

iterator

getNextMatchingNode

getCount

getCurrentNode

getContainer