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

All Superinterfaces:

InspectableContainer

All Known Subinterfaces:

Dictionary, InspectableDictionary, InspectableOrderedDictionary, KeyBasedContainer, OrderedDictionary, PriorityQueue

All Known Implementing Classes:

ArrayHeap, HashtableDictionary, RedBlackTree

public interface InspectableKeyBasedContainer
extends InspectableContainer

Please refer to the documentation of KeyBasedContainer.

Version:

JDSL 2.1.1

Author:

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

See Also:

KeyBasedContainer

Method Summary

ObjectIterator	keys() Returns an iterator over all the keys stored in this container.
LocatorIterator	locators() Allows access to all the locators stored by this container.

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

contains, elements, isEmpty, size

Method Detail

locators

LocatorIterator locators()

Allows access to all the locators stored by this container. No order is guaranteed, although subinterfaces or implementations may make a guarantee. The iterator returned is a snapshot -- that is, it iterates over all locators that were in the container at the moment that locators() was called, regardless of subsequent modifications to the container.

Returns:

a LocatorIterator over all of the locators in the container

keys

ObjectIterator keys()

Returns an iterator over all the keys stored in this container. No order is guaranteed, although subinterfaces or implementations may make a guarantee. The iterator returned is a snapshot -- that is, it iterates over all keys that were in the container at the moment that keys() was called, regardless of subsequent modifications to the container.

Returns:

an iterator over all the keys stored in this container