corelinux::AssociativeIterator< KeyType, ElementType > Class Template Reference

The AssociativeIterator that extends Iterator to include the interface for describing an associative collection type without exposing its underlying representation. More...

#include <AssociativeIterator.hpp>

Inheritance diagram for corelinux::AssociativeIterator< KeyType, ElementType >:

corelinux::Iterator< ElementType > corelinux::CoreLinuxObject corelinux::CoreLinuxAssociativeIterator< TraverseType, KeyType, ElementType >

List of all members.

Public Member Functions

 AssociativeIterator (void)
 Default constructor.
 AssociativeIterator (const AssociativeIterator &aRef)
 Copy constructor.
virtual ~AssociativeIterator (void)
 Destructor.
AssociativeIteratoroperator= (const AssociativeIterator &)
 Assignment operator.
bool operator== (const AssociativeIterator &aRef) const
 Equality operator.
virtual KeyType getKey (void) const =0 throw (IteratorBoundsException)
 getKey returns the KeyType instance that is currently pointed to by the AssociativeIterator


Detailed Description

template<class KeyType, class ElementType>
class corelinux::AssociativeIterator< KeyType, ElementType >

The AssociativeIterator that extends Iterator to include the interface for describing an associative collection type without exposing its underlying representation.

The implementation requires a template arguments that describes the KeyType and ElementType being iterated over.


Constructor & Destructor Documentation

template<class KeyType, class ElementType>
corelinux::AssociativeIterator< KeyType, ElementType >::AssociativeIterator ( const AssociativeIterator< KeyType, ElementType > &  aRef  )  [inline]

Copy constructor.

Parameters:
AssociativeIterator const reference


Member Function Documentation

template<class KeyType, class ElementType>
AssociativeIterator& corelinux::AssociativeIterator< KeyType, ElementType >::operator= ( const AssociativeIterator< KeyType, ElementType > &   )  [inline]

Assignment operator.

Parameters:
AssociativeIterator const reference
Returns:
AssociativeIterator reference

template<class KeyType, class ElementType>
bool corelinux::AssociativeIterator< KeyType, ElementType >::operator== ( const AssociativeIterator< KeyType, ElementType > &  aRef  )  const [inline]

Equality operator.

Parameters:
AssociativeIterator const reference
Returns:
bool - true if instances are equal

template<class KeyType, class ElementType>
virtual KeyType corelinux::AssociativeIterator< KeyType, ElementType >::getKey ( void   )  const throw (IteratorBoundsException) [pure virtual]

getKey returns the KeyType instance that is currently pointed to by the AssociativeIterator

Returns:
KeyType
Exceptions:
IteratorBoundsException if the AssociativeIterator is not positioned correctly.

Implemented in corelinux::CoreLinuxAssociativeIterator< TraverseType, KeyType, ElementType >.


The documentation for this class was generated from the following file:

This is the CoreLinux++ reference manual
Provided by The CoreLinux Consortium