Yate
Public Member Functions | Static Public Member Functions

ObjList Class Reference

An object list class. More...

#include <yateclass.h>

Inheritance diagram for ObjList:
GenObject JGRtpCandidates JGRtpMediaList

List of all members.

Public Member Functions

 ObjList ()
virtual ~ObjList ()
virtual void * getObject (const String &name) const
unsigned int length () const
unsigned int count () const
GenObjectget () const
GenObjectset (const GenObject *obj, bool delold=true)
ObjListnext () const
ObjListlast () const
ObjListskipNull () const
ObjListskipNext () const
GenObjectat (int index) const
ObjListoperator+ (int index) const
GenObjectoperator[] (signed int index) const
GenObjectoperator[] (unsigned int index) const
GenObjectoperator[] (const String &str) const
ObjListfind (const GenObject *obj) const
ObjListfind (const String &str) const
int index (const GenObject *obj) const
int index (const String &str) const
ObjListinsert (const GenObject *obj, bool compact=true)
ObjListappend (const GenObject *obj, bool compact=true)
GenObjectremove (bool delobj=true)
GenObjectremove (GenObject *obj, bool delobj=true)
GenObjectremove (const String &str, bool delobj=true)
void clear ()
bool autoDelete ()
void setDelete (bool autodelete)

Static Public Member Functions

static const ObjListempty ()

Detailed Description

An object list class.

A simple single-linked object list handling class


Constructor & Destructor Documentation

ObjList ( )

Creates a new, empty list.

virtual ~ObjList ( ) [virtual]

Destroys the list and everything in it.


Member Function Documentation

ObjList* append ( const GenObject obj,
bool  compact = true 
)

Append an object to the end of the list

Parameters:
objPointer to the object to append
compactTrue to replace NULL values in list if possible
Returns:
A pointer to the inserted list item

Referenced by MimeLinesBody::addLine(), MimeSdpBody::addLine(), MimeMultipartBody::appendBody(), MimeBody::appendHdr(), and JGSession::sendContent().

GenObject* at ( int  index) const

Get the object at a specific index in list

Parameters:
indexIndex of the object to retrive
Returns:
Pointer to the object or NULL
bool autoDelete ( ) [inline]

Get the automatic delete flag

Returns:
True if will delete on destruct, false otherwise
void clear ( )

Clear the list and optionally delete all contained objects

unsigned int count ( ) const

Get the number of non-null objects in the list

Returns:
Count of items
static const ObjList& empty ( ) [static]

A static empty object list

Returns:
Reference to a static empty list
ObjList* find ( const String str) const

Get the item in the list that holds an object by String value

Parameters:
strString value (toString) of the object to search for
Returns:
Pointer to the found item or NULL
ObjList* find ( const GenObject obj) const

Get the item in the list that holds an object

Parameters:
objPointer to the object to search for
Returns:
Pointer to the found item or NULL
GenObject* get ( ) const [inline]

Get the object associated to this list item

Returns:
Pointer to the object or NULL

Referenced by JIDResourceList::getFirst(), and JBStream::lastEvent().

virtual void* getObject ( const String name) const [virtual]

Get a pointer to a derived class given that class name

Parameters:
nameName of the class we are asking for
Returns:
Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from GenObject.

int index ( const GenObject obj) const

Get the position in list of a GenObject by a pointer to it

Parameters:
objPointer to the object to search for
Returns:
Index of object in list, -1 if not found
int index ( const String str) const

Get the position in list of the first GenObject with a given value

Parameters:
strString value (toString) of the object to search for
Returns:
Index of object in list, -1 if not found
ObjList* insert ( const GenObject obj,
bool  compact = true 
)

Insert an object at this point

Parameters:
objPointer to the object to insert
compactTrue to replace NULL values in list if possible
Returns:
A pointer to the inserted list item
ObjList* last ( ) const

Get the last item in the list

Returns:
Pointer to the last item in list

Referenced by JBStream::lastEvent().

unsigned int length ( ) const

Get the number of elements in the list

Returns:
Count of items
ObjList* next ( ) const [inline]

Get the next item in the list

Returns:
Pointer to the next item in list or NULL
ObjList* operator+ ( int  index) const

Pointer-like indexing operator

Parameters:
indexIndex of the list item to retrive
Returns:
Pointer to the list item or NULL
GenObject* operator[] ( signed int  index) const [inline]

Array-like indexing operator with signed parameter

Parameters:
indexIndex of the object to retrive
Returns:
Pointer to the object or NULL
GenObject* operator[] ( unsigned int  index) const [inline]

Array-like indexing operator with unsigned parameter

Parameters:
indexIndex of the object to retrive
Returns:
Pointer to the object or NULL
GenObject* operator[] ( const String str) const

Array-like indexing operator

Parameters:
strString value of the object to locate
Returns:
Pointer to the object or NULL
GenObject* remove ( const String str,
bool  delobj = true 
)

Delete the first list item that holds an object with a iven value

Parameters:
strString value (toString) of the object to remove
delobjTrue to delete the object (default)
Returns:
Pointer to the object if not destroyed
GenObject* remove ( GenObject obj,
bool  delobj = true 
)

Delete the list item that holds a given object

Parameters:
objObject to search in the list
delobjTrue to delete the object (default)
Returns:
Pointer to the object if not destroyed
GenObject* remove ( bool  delobj = true)

Delete this list item

Parameters:
delobjTrue to delete the object (default)
Returns:
Pointer to the object if not destroyed

Referenced by MimeMultipartBody::removeBody(), and MimeBody::removeHdr().

GenObject* set ( const GenObject obj,
bool  delold = true 
)

Set the object associated to this list item

Parameters:
objPointer to the new object to set
deloldTrue to delete the old object (default)
Returns:
Pointer to the old object if not destroyed
void setDelete ( bool  autodelete) [inline]

Set the automatic delete flag

Parameters:
autodeleteTrue to delete on destruct, false otherwise

Referenced by JGSession::sendContent().

ObjList* skipNext ( ) const

Advance in the list skipping over NULL holding items

Returns:
Pointer to the next non NULL holding item in list or NULL
ObjList* skipNull ( ) const

Skip over NULL holding items in the list

Returns:
Pointer to the first non NULL holding item in list or NULL

Referenced by JIDResourceList::getFirst().


The documentation for this class was generated from the following file: