UtlSortedList.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 _UtlSortedList_h_
#define _UtlSortedList_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlDefs.h"
#include "utl/UtlList.h"

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

class UtlSortedList : public UtlList
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    static const UtlContainableType TYPE;

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

   UtlSortedList();

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

    virtual UtlContainable* insert(UtlContainable* obj);

    virtual UtlContainable* remove(const UtlContainable*);


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

    virtual UtlContainable* find(const UtlContainable*) const;

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

    virtual size_t index(const UtlContainable* obj) const;

    virtual size_t occurrencesOf(const UtlContainable* obj) const;


    UtlContainableType getContainableType() const;
    

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    friend class UtlSortedListIterator;
    
    typedef enum {POSITION, EXACTLY} MatchType;

    UtlLink* findNode(UtlLink* starting, MatchType match, const UtlContainable* obj) const;

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

    /* for now, don't provide a copy constructor */
    UtlSortedList(UtlSortedList& rhs);
};

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

#endif    // _UtlSortedList_h_