UtlHashBagIterator Class Reference

#include <UtlHashBagIterator.h>

Inheritance diagram for UtlHashBagIterator:

Collaboration diagram for UtlHashBagIterator:

Public Member Functions
	UtlHashBagIterator (const UtlHashBag &hashBag, UtlContainable *key=NULL)
virtual	~UtlHashBagIterator ()
virtual UtlContainable *	operator() ()
virtual void	reset ()
UtlContainable *	key () const
Public Member Functions inherited from UtlIterator
	UtlIterator (const UtlContainer &container)
virtual	~UtlIterator ()=0

Protected Member Functions
virtual void	removing (const UtlLink *node)
Protected Member Functions inherited from UtlIterator
void	addToContainer (const UtlContainer *container)
virtual void	invalidate ()

Friends
class	UtlHashBag

Additional Inherited Members
Protected Attributes inherited from UtlIterator
OsBSem	mContainerRefLock
UtlContainer *	mpMyContainer

Detailed Description

UtlHashBagIterator allows developers to iterator (walks through) an UtlHashBag.

See also

UtlIterator

UtlSList

Constructor & Destructor Documentation

UtlHashBagIterator	(	const UtlHashBag &	hashBag,
		UtlContainable *	key = NULL
	)

Construct an iterator over all objects in a given UtlHashBag If key is specified, iterate only over objects that match that key (UtlHashBags may have any number of copies of a given object)

~UtlHashBagIterator ( )

virtual

Destructor

Member Function Documentation

UtlContainable * operator() ( )

virtual

Return the next element.

Returns

The next element or NULL if no more elements are available.

Implements UtlIterator.

void reset ( void  )

virtual

Reset the list by moving the iterator cursor to the location before the first element.

Implements UtlIterator.

UtlContainable * key

(

)

const

Gets the key of the current element

void removing ( const UtlLink *  node )

protectedvirtual

removing is called by the UtlHashMap when an element is about to be removed from the container. The iterator must ensure that the element for the removed node is not returned by any subsequent call.

Friends And Related Function Documentation

friend class UtlHashBag

friend