#include <OsContactList.h>
Inheritance diagram for OsContactList:
Collaboration diagram for OsContactList:
Public Member Functions | |
| OsContactList () | |
| void | setPrimary (const OsContact &contact) |
| const OsContact * | getPrimary () |
| virtual UtlContainableType | getContainableType () const |
 Public Member Functions inherited from UtlSList | |
| UtlSList () | |
| virtual UtlContainable * | append (UtlContainable *obj) |
| virtual UtlContainable * | insertAt (size_t N, UtlContainable *obj) |
| Insert the designated containable object at the designated position. More... | |
| virtual UtlContainable * | insert (UtlContainable *obj) |
| virtual UtlContainable * | remove (const UtlContainable *) |
| virtual UtlBoolean | destroy (UtlContainable *) |
| virtual UtlContainable * | find (const UtlContainable *) const |
| virtual size_t | occurrencesOf (const UtlContainable *obj) const |
| virtual size_t | index (const UtlContainable *obj) const |
| Public Member Functions inherited from UtlList | |
| virtual | ~UtlList () |
| UtlContainable * | get () |
| UtlContainable * | removeReference (const UtlContainable *obj) |
| UtlContainable * | removeAt (const size_t N) |
| void | destroyAll () |
| void | removeAll () |
| void | rehash () |
| virtual UtlContainable * | at (size_t N) const |
| virtual UtlContainable * | first () const |
| virtual UtlContainable * | last () const |
| virtual size_t | entries () const |
| virtual UtlBoolean | isEmpty () const |
| virtual UtlBoolean | contains (const UtlContainable *object) const |
| virtual UtlBoolean | containsReference (const UtlContainable *) const |
| Public Member Functions inherited from UtlContainer | |
| UtlContainer () | |
| virtual | ~UtlContainer () |
| virtual unsigned | hash () const |
| virtual int | compareTo (const UtlContainable *otherObject) const |
| Public Member Functions inherited from UtlContainable | |
| virtual | ~UtlContainable () |
| unsigned | directHash () const |
| Provides a hash function that uses the object pointer as the hash value. More... | |
| virtual UtlBoolean | isEqual (UtlContainable const *) const |
| Test this object to another object for equality. More... | |
| virtual UtlBoolean | isInstanceOf (const UtlContainableType type) const |
| Determine if this object is a derivative of the specified UtlContainableType. More... | |
| Public Member Functions inherited from UtlChain | |
| UtlChain () | |
| Constructor initializes to unlinked. More... | |
| ~UtlChain () | |
| Destructor. More... | |
Static Protected Attributes | |
| static const UtlContainableType | TYPE = "OsContactList" |
Friends | |
| class | OsContactListTest |
| class | UtlSListIterator |
Additional Inherited Members | |
| Static Public Member Functions inherited from UtlContainer | |
| static void | acquireIteratorConnectionLock () |
| Lock the linkage between containers and iterators. More... | |
| static void | releaseIteratorConnectionLock () |
| Unlock the linkage between containers and iterators. More... | |
| Static Public Member Functions inherited from UtlContainable | |
| static unsigned | stringHash (char const *value) |
| Provides a hash function appropriate for null-terminated string values. More... | |
| static UtlBoolean | areSameTypes (const UtlContainableType type1, const UtlContainableType type2) |
| Are UtlContainable types the same. More... | |
| Static Public Attributes inherited from UtlSList | |
| static const UtlContainableType | TYPE = "UtlSList" |
| Static Public Attributes inherited from UtlList | |
| static UtlContainableType | TYPE = "UtlList" |
| Static Public Attributes inherited from UtlContainer | |
| static const UtlContainableType | TYPE = "UtlContainer" |
| Static Public Attributes inherited from UtlContainable | |
| static const UtlContainableType | TYPE = "UtlContainable" |
| Protected Member Functions inherited from UtlSList | |
| virtual UtlContainable * | insertAfter (UtlLink *afterNode, UtlContainable *object) |
| Protected Member Functions inherited from UtlList | |
| UtlList () | |
| void | notifyIteratorsOfRemove (UtlLink *element) |
| virtual void | removeLink (UtlLink *toBeRemoved) |
| Protected Member Functions inherited from UtlContainer | |
| void | addIterator (UtlIterator *newIterator) const |
| Add an iterator to the list to be notified of changes to this container. More... | |
| void | removeIterator (UtlIterator *existingIterator) const |
| Called from iterator destructor to prevent further notices. More... | |
| void | invalidateIterators () |
| Call the invalidate method on all iterators. More... | |
| Protected Member Functions inherited from UtlChain | |
| bool | isUnLinked () const |
| Is this block not linked to anything? More... | |
| void | unchain () |
| Take the link out of its chain. More... | |
| void | chainBefore (UtlChain *existing) |
| Insert a new UtlChain before existing. More... | |
| void | chainAfter (UtlChain *existing) |
| Insert a new UtlChain after existing.. More... | |
| UtlChain * | listHead () const |
| Returns the head (first) UtlLink on the list (or NULL if the list is empty). More... | |
| UtlChain * | listTail () const |
| Returns the tail (last) UtlLink on the list (or NULL if the list is empty). More... | |
| UtlLink * | head () const |
| Returns the head (first) UtlLink on the list (or NULL if the list is empty). More... | |
| UtlLink * | tail () const |
| Returns the tail (last) UtlLink on the list (or NULL if the list is empty). More... | |
| void | listBefore (UtlChain *list, UtlChain *existing) |
| Insert this link into a list before an existing entry (before NULL == at the tail). More... | |
| void | listAfter (UtlChain *list, UtlChain *existing) |
| Insert this link into a list after an existing entry (after NULL == at the head). More... | |
| UtlChain * | detachFromList (UtlChain *listHead) |
| Remove a link from a list. More... | |
| Protected Attributes inherited from UtlContainer | |
| OsBSem | mContainerLock |
| Must be taken when making any change to container state. More... | |
| UtlChain | mIteratorList |
| Protected Attributes inherited from UtlChain | |
| UtlChain * | prev |
| backward chain pointer More... | |
| UtlChain * | next |
| forward chain pointer More... | |
Detailed Description
OsContactList is a simple extension of UtlSList that allows for the setting and getting of a 'primary' contact.
- See also
- UtlSList
- UtlContainer
- UtlContainable
Constructor & Destructor Documentation
| OsContactList | ( | ) |
Default Constructor
Member Function Documentation
| void setPrimary | ( | const OsContact & | contact | ) |
Method for designating a 'primary' contact, which may or may not already be in the list. If it is not already in the list it is added to the list.
- Parameters
-
contact The contact to set as the 'primary'.
| const OsContact * getPrimary | ( | ) |
Method for gettting the 'primary' contact. If no primary contact has be explicitly set with setPrimary, the first contact in the list is returned.
|
virtual |
Get the ContainableType for the OsContactList as a contained object.
Get the ContainableType for the list as a contained object.
Reimplemented from UtlSList.
Friends And Related Function Documentation
|
friend |
|
friend |
Member Data Documentation
|
staticprotected |
