The AssociativeIterator that extends Iterator to include the interface for describing an associative collection type without exposing its underlying representation. More...
#include <AssociativeIterator.hpp>
Public Member Functions | |
| AssociativeIterator (void) | |
| Default constructor. | |
| AssociativeIterator (const AssociativeIterator &aRef) | |
| Copy constructor. More... | |
| virtual | ~AssociativeIterator (void) |
| Destructor. | |
| AssociativeIterator & | operator= (const AssociativeIterator &) |
| Assignment operator. More... | |
| bool | operator== (const AssociativeIterator &aRef) const |
| Equality operator. More... | |
| virtual KeyType | getKey (void) const =0 throw (IteratorBoundsException) |
| getKey returns the KeyType instance that is currently pointed to by the AssociativeIterator More... | |
 Public Member Functions inherited from corelinux::Iterator< ElementType > | |
| Iterator (void) | |
| Default constructor. | |
| Iterator (const Iterator &aRef) | |
| Copy constructor. More... | |
| virtual | ~Iterator (void) |
| Destructor. | |
| Iterator & | operator= (const Iterator &) |
| Assignment operator. More... | |
| bool | operator== (const Iterator &aRef) const |
| Equality operator. More... | |
| virtual bool | isValid (void) const =0 |
| isValid abstract interface for implementation to determine if the current position points to a valid EntityType instance More... | |
| virtual ElementType | getElement (void) const =0 throw (IteratorBoundsException) |
| getElement returns the ElementType instance that is currently pointed to by the Iterator More... | |
| virtual void | setFirst (void)=0 |
| Set iterator to first element. | |
| virtual void | setNext (void)=0 throw (IteratorBoundsException) |
| Set iterator to next element. More... | |
| virtual void | setPrevious (void)=0 throw (IteratorBoundsException) |
| Set iterator to previous element. More... | |
| virtual void | setLast (void)=0 throw (IteratorBoundsException) |
| Set iterator to last element. More... | |
| Public Member Functions inherited from corelinux::CoreLinuxObject | |
| CoreLinuxObject (void) | |
| Default Constructor. | |
| CoreLinuxObject (CoreLinuxObjectCref) | |
| Copy Constructor. More... | |
| virtual | ~CoreLinuxObject (void) |
| Virtual Destructor. | |
| CoreLinuxObjectRef | operator= (CoreLinuxObjectCref) |
| Assignment operator overload. More... | |
| bool | operator== (CoreLinuxObjectCref) const |
| Equality operator overload. More... | |
| bool | operator!= (CoreLinuxObjectCref) const |
| Non-equality operator overload. More... | |
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
§ AssociativeIterator()
|
inline |
Copy constructor.
- Parameters
-
AssociativeIterator const reference
Member Function Documentation
§ getKey()
|
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 >.
Referenced by corelinux::AssociativeIterator< KeyType, ElementType >::operator==().
§ operator=()
|
inline |
Assignment operator.
- Parameters
-
AssociativeIterator const reference
- Returns
- AssociativeIterator reference
§ operator==()
|
inline |
Equality operator.
- Parameters
-
AssociativeIterator const reference
- Returns
- bool - true if instances are equal
References corelinux::AssociativeIterator< KeyType, ElementType >::getKey().
The documentation for this class was generated from the following file: