com.aspose.words

Class BuildingBlockCollection

java.lang.Object

com.aspose.words.NodeCollection

com.aspose.words.BuildingBlockCollection

All Implemented Interfaces:

java.lang.Iterable

public class BuildingBlockCollection
extends NodeCollection

A collection of BuildingBlock objects in the document.

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

You do not create instances of this class directly. To access a collection of building blocks use the GlossaryDocument.getBuildingBlocks() property.

See Also:

GlossaryDocument, GlossaryDocument.getBuildingBlocks(), BuildingBlock

Method Summary

Modifier and Type	Method and Description
Node	get(int index) Retrieves a building block at the given index.
Node[]	toArray() Copies all building blocks from the collection to a new array of building blocks.

Methods inherited from class com.aspose.words.NodeCollection

add, clear, contains, getContainer, getCount, getCurrentNode, getNextMatchingNode, indexOf, insert, iterator, remove, removeAt

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 building block 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.

Overrides:

get in class NodeCollection

Parameters:

index - An index into the list of building blocks.

Returns:

The corresponding BuildingBlock value.

toArray

public Node[] toArray()

Copies all building blocks from the collection to a new array of building blocks.

Overrides:

toArray in class NodeCollection

Returns:

An array of building blocks.