A set of (variable-name, variable-value) tuples. More...

#include <StringVars.h>

Inheritance diagram for utl::StringVars:

Public Member Functions
virtual int	compare (const utl::Object &rhs) const
	Compare with another object. More...

virtual void	copy (const utl::Object &rhs)
	Copy another instance. More...

virtual void	serialize (utl::Stream &stream, uint_t io, uint_t mode=utl::ser_default)
	Serialize to or from a stream. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

bool	empty () const
	Empty?

bool	isNull (const char *name) const
	Is the given variable null?

bool	isNull (const String &name) const
	Is the given variable null.

void	setNull (const char *name)
	Remove the given variable (make it null). More...

void	setNull (const String &name)
	Remove the given variable (make it null). More...

const String &	valueOf (const char *name) const
	Get the value of a variable. More...

const String &	valueOf (const String &name) const
	Get the value of a variable. More...

String &	valueOf (const char *name, bool create)
	Get the value of a variable (non-const version). More...

String &	valueOf (const String &name, bool create)
	Get the value of a variable (non-const version). More...

Pair *	setValue (const char name, const char value)
	Set a variable. More...

Pair *	setValue (const String &name, const char *value)
	Set a variable. More...

Pair *	setValue (const char *name, const String &value)
	Set a variable. More...

Pair *	setValue (const String &name, const String &value)
	Set a variable. More...

Pair *	setValue (String name, String value)
	Set a variable. More...

void	clear ()
	Clear out contents. More...

utl::Collection &	container ()
	Get the container. More...

const utl::Collection &	container () const
	Get the container. More...

void	add (const StringVars &vars)
	Add variables from another instance. More...

void	intersect (const utl::SortedCollection &vars)
	Intersect variables with given collection. More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. 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...

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

A set of (variable-name, variable-value) tuples.

Author: Adam McKee

Definition at line 28 of file StringVars.h.

Member Function Documentation

◆ compare()

virtual int utl::StringVars::compare ( const utl::Object & rhs ) const

virtual

Compare with another object.

If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.

See also: getKey

Returns: < 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs

Parameters

rhs	object to compare with

Reimplemented from utl::Object.

◆ copy()

virtual void utl::StringVars::copy ( const utl::Object & rhs )

virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters

rhs	object to copy

Reimplemented from utl::Object.

◆ serialize()

virtual void utl::StringVars::serialize	(	utl::Stream &	stream,
		uint_t	io,
		uint_t	mode = `utl::ser_default`
	)

virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters

stream	stream to serialize from/to
io	see utl::io_t
mode	see utl::serialize_t

Reimplemented from utl::Object.

◆ innerAllocatedSize()

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

virtual

Get the "inner" allocated size.

Reimplemented from utl::Object.

◆ setNull() [1/2]

void utl::StringVars::setNull ( const char * name )

inline

Remove the given variable (make it null).

Definition at line 60 of file StringVars.h.

◆ setNull() [2/2]

void utl::StringVars::setNull ( const String & name )

Remove the given variable (make it null).

◆ valueOf() [1/4]

const String& utl::StringVars::valueOf ( const char * name ) const

inline

Get the value of a variable.

Returns: variable value (empty string if not found)

Parameters

name	variable name

Definition at line 74 of file StringVars.h.

◆ valueOf() [2/4]

const String& utl::StringVars::valueOf ( const String & name ) const

Get the value of a variable.

Returns: variable value (empty string if not found)

Parameters

name	variable name

◆ valueOf() [3/4]

String& utl::StringVars::valueOf	(	const char *	name,
		bool	create
	)

inline

Get the value of a variable (non-const version).

Returns: variable value (empty string if not found)

Parameters

name	variable name
create	create the variable if it doesn't exist?

Definition at line 93 of file StringVars.h.

◆ valueOf() [4/4]

String& utl::StringVars::valueOf	(	const String &	name,
		bool	create
	)

Get the value of a variable (non-const version).

Returns: variable value (empty string if not found)

Parameters

name	variable name
create	create the variable if it doesn't exist?

◆ setValue() [1/5]

Pair* utl::StringVars::setValue	(	const char *	name,
		const char *	value
	)

inline

Set a variable.

Returns: utl::Pair* if the name wasn't known, nullptr otherwise

Parameters

name	variable name
value	variable value

Definition at line 113 of file StringVars.h.

◆ setValue() [2/5]

Pair* utl::StringVars::setValue	(	const String &	name,
		const char *	value
	)

inline

Set a variable.

Returns: utl::Pair* if the name wasn't known, nullptr otherwise

Parameters

name	variable name
value	variable value

Definition at line 125 of file StringVars.h.

◆ setValue() [3/5]

Pair* utl::StringVars::setValue	(	const char *	name,
		const String &	value
	)

inline

Set a variable.

Returns: utl::Pair* if the name wasn't known, nullptr otherwise

Parameters

name	variable name
value	variable value

Definition at line 137 of file StringVars.h.

◆ setValue() [4/5]

Pair* utl::StringVars::setValue	(	const String &	name,
		const String &	value
	)

inline

Set a variable.

Returns: utl::Pair* if the name wasn't known, nullptr otherwise

Parameters

name	variable name
value	variable value

Definition at line 149 of file StringVars.h.

◆ setValue() [5/5]

Pair* utl::StringVars::setValue	(	String *	name,
		String *	value
	)

Set a variable.

Returns: utl::Pair* if the name wasn't known, nullptr otherwise

Parameters

name	variable name
value	variable value

◆ clear()

void utl::StringVars::clear ( )

inline

Clear out contents.

Definition at line 164 of file StringVars.h.

◆ container() [1/2]

utl::Collection& utl::StringVars::container ( )

inline

Get the container.

Definition at line 171 of file StringVars.h.

◆ container() [2/2]

const utl::Collection& utl::StringVars::container ( ) const

inline

Get the container.

Definition at line 178 of file StringVars.h.

References ASSERTD, utl::deInit(), utl::init(), and utl::intersect().

◆ add()

void utl::StringVars::add ( const StringVars & vars )

Add variables from another instance.

◆ intersect()

void utl::StringVars::intersect ( const utl::SortedCollection & vars )

Intersect variables with given collection.

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

StringVars.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compare()

◆ copy()

◆ serialize()

◆ innerAllocatedSize()

◆ setNull() [1/2]

◆ setNull() [2/2]

◆ valueOf() [1/4]

◆ valueOf() [2/4]

◆ valueOf() [3/4]

◆ valueOf() [4/4]

◆ setValue() [1/5]

◆ setValue() [2/5]

◆ setValue() [3/5]

◆ setValue() [4/5]

◆ setValue() [5/5]

◆ clear()

◆ container() [1/2]

◆ container() [2/2]

◆ add()

◆ intersect()