craterdog.collections.interfaces

Interface Iteratable<E>

Type Parameters:

E - The type of element managed by the collection.

All Superinterfaces:

Composite, java.lang.Iterable<E>, Sequential<E>

All Known Subinterfaces:

Accessible<E>, Associative<K,V>, FIFO<E>, Indexed<E>, LIFO<E>, Ordered<E>, Sortable<E>

All Known Implementing Classes:

Bag, Collection, Dictionary, List, Map, OrderedCollection, Queue, Set, SortableCollection, Stack

public interface Iteratable<E>
extends Sequential<E>, Composite

This interface defines the methods that must be implemented by each collection whose elements can be iterated over.

Author:

Derk Norton

Method Summary

Modifier and Type	Method and Description
Iterator<E>	createDefaultIterator() This method creates a new default iterator for the collection.
void	removeAllElements() This method removes all elements from the collection.

Methods inherited from interface craterdog.core.Sequential

getNumberOfElements, isEmpty, iterator, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface craterdog.core.Composite

toString

Method Detail

createDefaultIterator

Iterator<E> createDefaultIterator()

This method creates a new default iterator for the collection.

Returns:

A new default iterator for the collection.

removeAllElements

void removeAllElements()

This method removes all elements from the collection.