utl::ObjectRegistry Class Reference

Object registry. More...

#include <ObjectRegistry.h>

Inheritance diagram for utl::ObjectRegistry:

Public Member Functions
	ObjectRegistry (Ordering *ordering)
	Constructor. More...
virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...
void	setOrdering (Ordering *ordering)
	Set the ordering (registry must be empty). More...
Object *	add (Object *object)
	Add a reference to an object. More...
void	remove (Object *object)
	Remove a reference to an object. More...
RWlock &	lock ()
	Access the lock. More...
iterator	begin ()
	Get begin iterator. More...
iterator	end ()
	Get end iterator. More...
Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...
virtual int	compare (const Object &rhs) const
	Compare with another object. More...
virtual void	copy (const Object &rhs)
	Copy another instance. More...
virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...
virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...
virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...
void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...
virtual const Object &	getKey () const
	Get the key for this object. More...
bool	hasKey () const
	Determine whether or not the object has a key. More...
virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...
virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...
virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...
bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...
virtual String	toString () const
	Return a string representation of self. More...
	operator String () const
	Conversion to String. More...
size_t	allocatedSize () const
	Get the total allocated size of this object. More...
virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...
virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...
bool	operator< (const Object &rhs) const
	Less-than operator. More...
bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...
bool	operator> (const Object &rhs) const
	Greater-than operator. More...
bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...
bool	operator== (const Object &rhs) const
	Equal-to operator. More...
bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...
void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...
void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...
virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...
void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...
static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...
static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...
static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...
static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Object registry.

ObjectRegistry uses reference-counting to keep a "registry" of unique objects, and avoid duplication of objects that are equivalent.

If you don't supply an ordering, the objects' "native" ordering will be used via utl::Object::compare(). ObjectRegistry will automatically order objects of differing types based on their type names, so the provided ordering (or native object ordering) will only be invoked when the objects being compared are of the same type.

Author

Adam McKee

Definition at line 31 of file ObjectRegistry.h.

Constructor & Destructor Documentation

ObjectRegistry()

utl::ObjectRegistry::ObjectRegistry ( Ordering *  ordering )

inline

Constructor.

Definition at line 44 of file ObjectRegistry.h.

References utl::init().

Member Function Documentation

innerAllocatedSize()

virtual size_t utl::ObjectRegistry::innerAllocatedSize ( ) const

virtual

Get the "inner" allocated size.

Reimplemented from utl::Object.

setOrdering()

void utl::ObjectRegistry::setOrdering

(

Ordering *

ordering

)

Set the ordering (registry must be empty).

add()

Object* utl::ObjectRegistry::add

(

Object *

object

)

Add a reference to an object.

Returns

registry's copy of the object

Parameters

object

(this pointer should be discarded by client)

remove()

void utl::ObjectRegistry::remove

(

Object *

object

)

Remove a reference to an object.

Parameters

object

utl::Object* returned by earlier call to add()

lock()

RWlock& utl::ObjectRegistry::lock ( )

inline

Access the lock.

Definition at line 70 of file ObjectRegistry.h.

begin()

iterator utl::ObjectRegistry::begin ( )

inline

Get begin iterator.

Definition at line 77 of file ObjectRegistry.h.

end()

iterator utl::ObjectRegistry::end ( )

inline

Get end iterator.

Definition at line 84 of file ObjectRegistry.h.

---

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

• ObjectRegistry.h