iCollection Struct Reference

Inheritance diagram for iCollection:

Detailed Description

Immutable Collection interface.

Public Member Functions
virtual tType	GetKeyType () const =0
	Get the collection's key type. {Property}. More...
virtual tType	GetValueType () const =0
	Get the collection's value type. {Property}. More...
virtual tBool	IsEmpty () const =0
	Returns true if this collection contains no elements. More...
virtual tU32	GetSize () const =0
	Returns the number of elements in this collection. More...
virtual tBool	Contains (const Var &aVar) const =0
	Returns true if this collection contains the specified key. More...
virtual tBool	ContainsAll (const iCollection *apCollection) const =0
	Returns true if this collection contains all of the elements in the specified collection. More...
virtual iIterator *	Iterator () const =0
	Returns an iterator over the elements in this collection. More...
virtual iIterator *	Find (const Var &aVar) const =0
	Returns an iterator over starting at the specified elements in this collection. More...
virtual Var	Get (const Var &aKey) const =0
	Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. More...
virtual Var	GetFirst () const =0
	Returns the first value in the container. {Property}. More...
virtual Var	GetLast () const =0
	Returns the last value in the container. {Property}. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tType GetKeyType ( ) const

pure virtual

Get the collection's key type. {Property}.

Remarks

Only Associative collections return a valid type here. Although Vector collections can use Put/Get with an index, it is not considered a "key" type.

virtual tType GetValueType ( ) const

pure virtual

Get the collection's value type. {Property}.

virtual tBool IsEmpty ( ) const

pure virtual

Returns true if this collection contains no elements.

virtual tU32 GetSize ( ) const

pure virtual

Returns the number of elements in this collection.

virtual tBool Contains ( const Var &  aVar ) const

pure virtual

Returns true if this collection contains the specified key.

virtual tBool ContainsAll ( const iCollection *  apCollection ) const

pure virtual

Returns true if this collection contains all of the elements in the specified collection.

virtual iIterator* Iterator ( ) const

pure virtual

Returns an iterator over the elements in this collection.

virtual iIterator* Find ( const Var &  aVar ) const

pure virtual

Returns an iterator over starting at the specified elements in this collection.

virtual Var Get ( const Var &  aKey ) const

pure virtual

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

virtual Var GetFirst ( ) const

pure virtual

Returns the first value in the container. {Property}.

virtual Var GetLast ( ) const

pure virtual

Returns the last value in the container. {Property}.