openldap/contrib/ldapc++/src/LDAPReferenceList.h

/*
 * Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
 */

#ifndef LDAP_REFERENCE_LIST_H
#define LDAP_REFERENCE_LIST_H

#include <list>

class LDAPSearchReference;

typedef list<LDAPSearchReference> RefList;

/**
 * Container class for storing a list of Search References
 *
 * Used internally only by LDAPSearchResults
 */
class LDAPReferenceList{
    public:
	typedef RefList::const_iterator const_iterator;

        /**
         * Constructs an empty list.
         */   
        LDAPReferenceList();

        /**
         * Copy-constructor
         */
        LDAPReferenceList(const LDAPReferenceList& rl);

        /**
         * Destructor
         */
        ~LDAPReferenceList();

        /**
         * @return The number of LDAPSearchReference-objects that are 
         * currently stored in this list.
         */
        size_t size() const;

        /**
         * @return A iterator that points to the first element of the list.
         */
        const_iterator begin() const;

        /**
         * @return A iterator that points to the element after the last
         * element of the list.
         */
        const_iterator end() const;

        /**
         * Adds one element to the end of the list.
         * @param e The LDAPSearchReference to add to the list.
         */
        void addReference(const LDAPSearchReference& e);

    private:
        RefList m_refs;
};
#endif // LDAP_REFERENCE_LIST_H