UtlPair Class Reference

Associate a key object (the parent UtlLink data) with its value object. More...

#include <UtlLink.h>

Inheritance diagram for UtlPair:

Collaboration diagram for UtlPair:

Protected Member Functions
	UtlPair ()
	~UtlPair ()
void	release ()
	Return a UtlPair to the pool. More...
Protected Member Functions inherited from UtlLink
UtlContainable *	unlink ()
	Take the link block out of its list, and return the data pointer. More...
UtlContainable *	detachFrom (UtlChain *listHead)
	Remove a link from a list. More...
	UtlLink ()
	The UtlLink constructor is protected. More...
	~UtlLink ()
	Destructor. More...
void	release ()
	Return a UtlLink to the pool. More...
void	rehash ()
	Recalculate the hash for this item. 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...

Static Protected Member Functions
static UtlPair *	get ()
	Get a UtlPair from the pool. More...
Static Protected Member Functions inherited from UtlLink
static UtlLink *	before (UtlChain *existing, UtlContainable *newData)
	Insert a new UtlLink to newData before existing, returning the new UtlLink. More...
static UtlLink *	after (UtlChain *existing, UtlContainable *newData)
	Insert a new UtlLink to newData after existing, returning the new UtlLink. More...
static UtlLink *	listBefore (UtlChain *list, UtlChain *existing, UtlContainable *newData)
	Insert a new item into a list before an existing entry (before NULL == at the tail). More...
static UtlLink *	listAfter (UtlChain *list, UtlChain *existing, UtlContainable *newData)
	Insert a new item into a list before an existing entry (after NULL == at the head). More...
static UtlLink *	findData (UtlChain *list, UtlContainable *target)
	Find the first matching target in the list by reference. More...
static UtlLink *	get ()
	Get a UtlLink from the pool. More...

Protected Attributes
UtlContainable *	value
Protected Attributes inherited from UtlChain
UtlChain *	prev
	backward chain pointer More...
UtlChain *	next
	forward chain pointer More...

Static Protected Attributes
static UtlChainPool *	spPairPool

Friends
class	UtlHashMap
class	UtlHashMapIterator
class	UtlHashBagIterator
class	UtlInit

Additional Inherited Members
Public Member Functions inherited from UtlLink
UtlLink *	next () const
	Returns the next UtlLink forward in a chain (or NULL for the end). More...
UtlLink *	prev () const
	Returns the next UtlLink backward in a chain (or NULL for the end). More...
UtlLink *	findDataRef (UtlContainable *target) const
	Linear search starting at this link for a matching data value. More...
UtlLink *	findNextHash (unsigned targetHash) const
	Linear search starting at this link for a matching data value. More...
Public Member Functions inherited from UtlChain
	UtlChain ()
	Constructor initializes to unlinked. More...
	~UtlChain ()
	Destructor. More...
Static Public Member Functions inherited from UtlLink
static size_t	totalAllocated ()
	Get the total number of UtlLink blocks allocated. More...
Public Attributes inherited from UtlLink
UtlContainable *	data
	The containable object whose place in the list this UtlLink is tracking. More...
unsigned	hash
	The hash code for the containable object whose place in the list this UtlLink is tracking. More...

Detailed Description

Associate a key object (the parent UtlLink data) with its value object.

Constructor & Destructor Documentation

UtlPair ( )

inlineprotected

~UtlPair ( )

inlineprotected

Member Function Documentation

UtlPair * get ( )

staticprotected

Get a UtlPair from the pool.

void release ( void  )

protected

Return a UtlPair to the pool.

Friends And Related Function Documentation

friend class UtlHashMap

friend

friend class UtlHashMapIterator

friend

friend class UtlHashBagIterator

friend

friend class UtlInit

friend

Member Data Documentation

UtlContainable* value

protected

UtlChainPool * spPairPool

staticprotected