UtlListIterator.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 _UtlListIterator_h_
#define _UtlListIterator_h_

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

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

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

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

    UtlListIterator(const UtlList& list) ;

    virtual ~UtlListIterator();

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

    virtual UtlContainable* operator()() ;

    virtual void reset() ; 

    virtual UtlContainable* findNext(const UtlContainable* objectToFind) = 0;

    virtual UtlContainable* toLast() ;

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

    UtlContainable* item() const;

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

    UtlBoolean atLast() const ;

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    UtlLink* mpCurrentNode;

    friend class UtlList;
    friend class UtlInit;

    virtual void removing(const UtlLink* node);


    static UtlLink const* OFF_LIST_END;
    
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    
    static OsBSem sIteratorListLock;
} ;

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

#endif    // _UtlListIterator_h_