UtlHashMapIterator.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _UtlHashMapIterator_h_
#define _UtlHashMapIterator_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlDefs.h"
#include "utl/UtlIterator.h"
#include "utl/UtlHashMap.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class UtlContainable;
class UtlPair;

class UtlHashMapIterator : public UtlIterator
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
  public:

/* ============================ CREATORS ================================== */

   UtlHashMapIterator(const UtlHashMap& hashMap);


   virtual ~UtlHashMapIterator();

/* ============================ MANIPULATORS ============================== */

   virtual UtlContainable* operator()();


   virtual void reset(); 


/* ============================ ACCESSORS ================================= */

   UtlContainable* key() const;


   UtlContainable* value() const;

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
  protected:
   friend class UtlHashMap;

   virtual void removing(const UtlPair* key);


/* //////////////////////////// PRIVATE /////////////////////////////////// */
  private:

   void init();

   size_t   mPosition;      
   UtlPair* mpCurrentPair;  
   bool     mPairIsValid;   
   // no copy constructor
   UtlHashMapIterator(UtlHashMapIterator&);
   
};

/* ============================ INLINE METHODS ============================ */

#endif    // _UtlHashMapIterator_h_