Cpl::Text::StringItem Class Reference

This partially concrete provides a wrapper class that allows a String object to be stored directly in one the CPL Containers. More...

Detailed Description

This partially concrete provides a wrapper class that allows a String object to be stored directly in one the CPL Containers.

A StringItem can be stored in a SList, DList, Dictionary, and Map.

Notes:

o The allocation of the actual String is deferred to child classes.
o When storing a StringItem in a 'keyed' container (i.e. Dictionary
  and Map) the application MUST NOT change the value of the internal
  string since it is the 'key' value that is used to determine its
  placement in the Dictionary/Map. Modifying the internal String while
  the StringItem is in a Dictionary/Map will CORRUPT the Container.
o StringItem instances CANNOT be copied.  This is to avoid potential
  Container corruption since the individual Items contain the memory
  for the Containers' linkage, i.e. a copied container Item is
  analogous to storing a single Item in more than one Container at the
  same time.

#include <StringItem.h>

Inheritance diagram for Cpl::Text::StringItem:

Collaboration diagram for Cpl::Text::StringItem:

Public Member Functions
String &	get () const
	Returns a reference to the actual String.
const char *	getString () const
	Returns a pointer to the internal C string.
	operator String & () const
	Cast to a String reference.
	operator const char * () const
	Cast to read-only character string pointer.
const char *	operator() () const
	Returns a Read-only pointer to the "raw" (short-hand for getString())
const Cpl::Container::Key &	getKey () const noexcept
	Return Cpl::Container::DictItem (used with Maps and Dictionaries)
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Member Functions
	StringItem (String &string)
	Constructor.
Protected Member Functions inherited from Cpl::Container::MapItem
	MapItem ()
	Constructor.
	MapItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor -->special constructor to allow a Map to be statically allocated.
void	initialize (MapItem *parent)
	Initialize the node when being inserted in the tree.
MapItem *	getParent () const
	Get tree connection/pointer.
void	setParent (MapItem *n)
	Set tree connection/pointer.
MapItem *	getLeft () const
	Get tree connection/pointer.
void	setLeft (MapItem *n)
	Set tree connection/pointer.
MapItem *	getRight () const
	Get tree connection/pointer.
void	setRight (MapItem *n)
	Set tree connection/pointer.
Protected Member Functions inherited from Cpl::Container::DictItem
	DictItem ()
	Constructor.
	DictItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.
	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes
String &	m_myString
	Reference to the actual String/storage.
Protected Attributes inherited from Cpl::Container::MapItem
void *	m_parentPtr_
	Link field to the parent node.
bool	m_is_NOT_root_
	I am the root node.
Balance_T	m_balance_
	Balance status.
Protected Attributes inherited from Cpl::Container::DictItem
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Types inherited from Cpl::Container::MapItem
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...

Constructor & Destructor Documentation

StringItem()

Cpl::Text::StringItem::StringItem ( String &  string )

inlineprotected

Constructor.

Member Function Documentation

get()

String & Cpl::Text::StringItem::get ( ) const

inline

Returns a reference to the actual String.

getKey()

const Cpl::Container::Key & Cpl::Text::StringItem::getKey ( ) const

inlinevirtualnoexcept

Return Cpl::Container::DictItem (used with Maps and Dictionaries)

Implements Cpl::Container::DictItem.

getString()

const char * Cpl::Text::StringItem::getString ( ) const

inline

Returns a pointer to the internal C string.

operator const char *()

Cpl::Text::StringItem::operator const char * ( ) const

inline

Cast to read-only character string pointer.

operator String &()

Cpl::Text::StringItem::operator String & ( ) const

inline

Cast to a String reference.

operator()()

const char * Cpl::Text::StringItem::operator() ( ) const

inline

Returns a Read-only pointer to the "raw" (short-hand for getString())

Member Data Documentation

m_myString

String& Cpl::Text::StringItem::m_myString

protected

Reference to the actual String/storage.

---

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

• Cpl/Text/StringItem.h