GenericAssociativeContainerBase< T, TImplementation, TObject > Class Template Reference

Inheritance diagram for GenericAssociativeContainerBase< T, TImplementation, TObject >:

Collaboration diagram for GenericAssociativeContainerBase< T, TImplementation, TObject >:

Public Member Functions
virtual	~GenericAssociativeContainerBase (void)=0
virtual bool	operator== (const T &toCompare) const
virtual bool	operator!= (const T &toCompare) const
virtual void	put (const T &src)
virtual void	removeAt (unsigned int index)
virtual void	removeAllElements (void)
virtual JString &	toString (JString &retStr, bool withTypes=false) const
virtual const TImplementation &	getHashtable (void) const
virtual unsigned int	getSize (void) const
virtual JString &	toString (JString &retStr, bool withTypes=false) const=0
JString	toString (bool withTypes=false) const
Public Member Functions inherited from Base
virtual	~Base (void)=0
Public Member Functions inherited from LoggingBase< Base >
virtual	~LoggingBase (void)=0
Public Member Functions inherited from ToString
virtual	~ToString (void)
virtual JString	typeToString (void) const
JString	toString (bool withTypes=false) const

Additional Inherited Members
Static Public Member Functions inherited from LoggingBase< Base >
static void	setListener (const BaseListener *pBaseListener)
static int	getDebugOutputLevel (void)
static bool	setDebugOutputLevel (int debugLevel)
static const LogFormatOptions &	getLogFormatOptions (void)
static void	setLogFormatOptions (const LogFormatOptions &options)

Constructor & Destructor Documentation

~GenericAssociativeContainerBase()

~GenericAssociativeContainerBase ( void  )

pure virtual

Destructor.

Member Function Documentation

operator==()

bool operator== ( const T &  toCompare ) const

virtual

operator==.

Returns

true, if both operands are equal, false otherwise.

Two instances are considered equal if they each hold the same number of entries and, for a given key, the corresponding values equal each other.

Two values are considered equal to each other, if instances of class OT, that are holding them as payloads, equal each other.

See also

OT::operator==()

Reimplemented in GenericAssociativeContainer< T, EKeyType, EValueType >, GenericAssociativeContainer< JSortedList, EKeyType, EValueType >, GenericAssociativeContainer< JDictionary, nByte, int >, GenericAssociativeContainer< JDictionary, nByte, Common::Helpers::SharedPointer< ExitGames::Voice::LocalVoice > >, GenericAssociativeContainer< JDictionary, int, ExitGames::Common::JVector< Common::Helpers::SharedPointer< ExitGames::Voice::LocalVoice > > >, GenericAssociativeContainer< JDictionary, int, ExitGames::Common::JDictionary< nByte, Common::Helpers::SharedPointer< ExitGames::Voice::RemoteVoice > > >, GenericAssociativeContainer< JDictionary, EKeyType, EValueType >, Dictionary< EKeyType, EValueType >, Dictionary< nByte, ExitGames::Common::Object >, Dictionary< ExitGames::Common::Object, ExitGames::Common::Object >, and Dictionary< nByte, Common::Object >.

operator!=()

bool operator!= ( const T &  toCompare ) const

virtual

operator!=.

Returns

false, if operator==() would return true, true otherwise.

Reimplemented in GenericAssociativeContainer< T, EKeyType, EValueType >, GenericAssociativeContainer< JSortedList, EKeyType, EValueType >, GenericAssociativeContainer< JDictionary, nByte, int >, GenericAssociativeContainer< JDictionary, nByte, Common::Helpers::SharedPointer< ExitGames::Voice::LocalVoice > >, GenericAssociativeContainer< JDictionary, int, ExitGames::Common::JVector< Common::Helpers::SharedPointer< ExitGames::Voice::LocalVoice > > >, GenericAssociativeContainer< JDictionary, int, ExitGames::Common::JDictionary< nByte, Common::Helpers::SharedPointer< ExitGames::Voice::RemoteVoice > > >, GenericAssociativeContainer< JDictionary, EKeyType, EValueType >, Dictionary< EKeyType, EValueType >, Dictionary< nByte, ExitGames::Common::Object >, Dictionary< ExitGames::Common::Object, ExitGames::Common::Object >, and Dictionary< nByte, Common::Object >.

put()

void put ( const T &  src )

virtual

Adds all pairs of a key and a corresponding value from the passed instance to the instance, on which it is called on. If a key is already existing, then its old value will be replaced with the new one.

Parameters

src	instance, from which to add the content

Returns

nothing.

Reimplemented in GenericAssociativeContainer< T, EKeyType, EValueType >, GenericAssociativeContainer< JSortedList, EKeyType, EValueType >, GenericAssociativeContainer< JDictionary, nByte, int >, GenericAssociativeContainer< JDictionary, nByte, Common::Helpers::SharedPointer< ExitGames::Voice::LocalVoice > >, GenericAssociativeContainer< JDictionary, int, ExitGames::Common::JVector< Common::Helpers::SharedPointer< ExitGames::Voice::LocalVoice > > >, GenericAssociativeContainer< JDictionary, int, ExitGames::Common::JDictionary< nByte, Common::Helpers::SharedPointer< ExitGames::Voice::RemoteVoice > > >, GenericAssociativeContainer< JDictionary, EKeyType, EValueType >, Dictionary< EKeyType, EValueType >, Dictionary< nByte, ExitGames::Common::Object >, Dictionary< ExitGames::Common::Object, ExitGames::Common::Object >, and Dictionary< nByte, Common::Object >.

removeAt()

void removeAt ( unsigned int  index )

virtual

Deletes the key and the value at the specified index, if the specified index is smaller than the return value of getSize().

Parameters

index

the index at which the key and value should be deleted.

Returns

nothing.

See also

remove(), removeAllElements()

removeAllElements()

void removeAllElements ( void  )

virtual

Clears the Hashtable, which means deleting all its content.

Returns

nothing.

See also

remove(), removeAt()

toString() [1/3]

JString & toString ( JString &  retStr, bool  withTypes = false  ) const

virtual

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

Implements ToString.

Reimplemented in Dictionary< EKeyType, EValueType >, Dictionary< nByte, ExitGames::Common::Object >, Dictionary< ExitGames::Common::Object, ExitGames::Common::Object >, Dictionary< nByte, Common::Object >, and DictionaryBase.

getHashtable()

const TImplementation & getHashtable ( void  ) const

virtual

Returns

a readonly reference to a TImplementation representation of the Dictionary instance. The returned reference refers to the original payload data of the Dictionary, so its payload will change, if the payload of the according Dictionary instance changes.

getSize()

unsigned int getSize ( void  ) const

virtual

Returns

the number of key/value pairs stored in the Hashtable.

toString() [2/3]

toString

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

toString() [3/3]

JString toString

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

withTypes

set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

See also

JString