nz.ac.waikato.jdsl.core.api
Interface InspectablePositionalContainer

All Superinterfaces:

InspectableContainer

All Known Subinterfaces:

BinaryTree, Graph, InspectableBinaryTree, InspectableGraph, InspectableSequence, InspectableTree, ModifiableGraph, PositionalContainer, Sequence, Tree

All Known Implementing Classes:

AbstractGraph, AbstractPositionalContainer, ArraySequence, IncidenceListGraph, NodeBinaryTree, NodeSequence, NodeTree

public interface InspectablePositionalContainer
extends InspectableContainer

Please refer to the documentation of PositionalContainer.

Version:

JDSL 2.1.1

Author:

Mark Handy (mdh), Andrew Schwerin (schwerin), Luca Vismara (lv)

See Also:

InspectableContainer, PositionalContainer

Method Summary

PositionIterator

positions() Provides an iterator over all of the positions of the container.

Methods inherited from interface nz.ac.waikato.jdsl.core.api.InspectableContainer

contains, elements, isEmpty, size

Method Detail

positions

PositionIterator positions()

Provides an iterator over all of the positions of the container. No order is specified. However, certain implementations of PositionalContainer may guarantee an order in which the iterator iterates over the positions. The iterator returned is a snapshot -- that is, it iterates over all positions that were in the container at the moment that positions() was called, regardless of subsequent modifications to the container.

Returns:

A PositionIterator over all positions in the container