UtlListIterator Class Reference

#include <UtlListIterator.h>

Inheritance diagram for UtlListIterator:

Collaboration diagram for UtlListIterator:

Public Member Functions
	UtlListIterator (const UtlList &list)
virtual	~UtlListIterator ()
virtual UtlContainable *	operator() ()
virtual void	reset ()
virtual UtlContainable *	findNext (const UtlContainable *objectToFind)=0
virtual UtlContainable *	toLast ()
UtlContainable *	item () const
UtlBoolean	atLast () 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 ()

Protected Attributes
UtlLink *	mpCurrentNode
Protected Attributes inherited from UtlIterator
OsBSem	mContainerRefLock
UtlContainer *	mpMyContainer

Static Protected Attributes
static UtlLink const *	OFF_LIST_END

Friends
class	UtlList
class	UtlInit

Detailed Description

UtlListIterator allows developers to iterator (walks through) an UtlList.

See also

UtlIterator

UtlList

Constructor & Destructor Documentation

UtlListIterator

(

const UtlList &

list

)

Constructor accepting a source UtlList

~UtlListIterator ( )

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.

virtual UtlContainable* findNext ( const UtlContainable *  objectToFind )

pure virtual

Find the designated object, and reset the iterator so that it is the current position.

Returns

The element or NULL if no more elements are available.

Implemented in UtlSortedListIterator, and UtlSListIterator.

UtlContainable * toLast ( )

virtual

Move the iterator to the last element within the iterator.

UtlContainable * item

(

)

const

return the current value .

UtlBoolean atLast

(

)

const

Is the iterator positioned at the last element?

void removing ( const UtlLink *  node )

protectedvirtual

removing is called by the UtlList 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.

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

Friends And Related Function Documentation

friend class UtlList

friend

friend class UtlInit

friend

Member Data Documentation

UtlLink* mpCurrentNode

protected

const UtlLink * OFF_LIST_END

staticprotected