UtlList.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 _UtlList_h_
#define _UtlList_h_

//#define GLIST_SANITY_TEST
#ifdef LIST_SANITY_TEST
# include "assert.h"
#endif

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

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

class UtlList : public UtlContainer, public UtlChain                                               
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    static UtlContainableType TYPE ;    
/* ============================ CREATORS ================================== */

// this base class cannot be instantiated directly - the constructor is protected

// Destructor
    virtual ~UtlList();

/* ============================ MANIPULATORS ============================== */
   
    UtlContainable* get() ;  

    UtlContainable* removeReference(const UtlContainable* obj);    

    virtual UtlContainable* remove(const UtlContainable* object) = 0;

    UtlContainable* removeAt(const size_t N);

    virtual UtlBoolean destroy(UtlContainable*);

    void destroyAll();

    void removeAll();

    void rehash();

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

    virtual UtlContainable* find(const UtlContainable*) const = 0;

    virtual UtlContainable* at(size_t N) const;

    virtual UtlContainable* first() const ;

    virtual UtlContainable* last() const ;

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

    virtual size_t entries() const;

    virtual UtlBoolean isEmpty() const;

    virtual UtlBoolean contains(const UtlContainable* object) const;

    virtual UtlBoolean containsReference(const UtlContainable *) const ;

    virtual size_t occurrencesOf(const UtlContainable* obj) const = 0;

    virtual size_t index(const UtlContainable* obj) const = 0;


   virtual UtlContainableType getContainableType() const;

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:


    UtlList();
    
    friend class UtlListIterator;

    void notifyIteratorsOfRemove(UtlLink* element);

    virtual void removeLink(UtlLink* toBeRemoved);

#ifdef LIST_SANITY_TEST
#  define LIST_SANITY_CHECK { if (!sanityCheck()){ assert(FALSE); } }
    bool sanityCheck() const;
#else
#  define LIST_SANITY_CHECK /* sanityCheck() */
#endif

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
} ;

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

#endif    // _UtlList_h_