MatchingItemBase Class Reference

Matching item common interface. More...

#include <yateclass.h>

Inheritance diagram for MatchingItemBase:

Public Member Functions
	MatchingItemBase (const char *name, bool negated=false)
const String &	name () const
bool	negated () const
bool	matchString (const String &str, MatchingParams *params=0) const
bool	matchListParam (const NamedList &list, MatchingParams *params=0) const
virtual bool	runMatchString (const String &str, MatchingParams *params=0) const
virtual bool	runMatchListParam (const NamedList &list, MatchingParams *params=0) const
virtual MatchingItemBase *	copy () const
virtual const MatchingItemString *	itemString () const
virtual const MatchingItemRegexp *	itemRegexp () const
virtual const MatchingItemRandom *	itemRandom () const
virtual const MatchingItemList *	itemList () const
virtual const MatchingItemCustom *	itemCustom () const
virtual String &	dump (String &buf, const MatchingItemDump *dump=0, const String &indent=String::empty(), const String &origIndent=String::empty(), unsigned int depth=0) const
virtual String &	dumpValue (String &buf, const MatchingItemDump *dump=0, const String &indent=String::empty(), const String &origIndent=String::empty(), unsigned int depth=0) const
virtual GenObject *	dumpXml (const MatchingItemDump *dump=0, unsigned int depth=0) const
virtual const String &	toString () const
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	traceId () const
virtual void *	getObject (const String &name) const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)

Friends
class	MatchingItemList

Additional Inherited Members
Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)
static bool	getObjCounting ()
static void	setObjCounting (bool enable)
static NamedCounter *	getObjCounter (const String &name, bool create=true)
static ObjList &	getObjCounters ()

Detailed Description

Matching item common interface.

Base class for all matching items

Constructor & Destructor Documentation

MatchingItemBase()

MatchingItemBase ( const char * name, bool negated = false )

inline

Constructor

Parameters

name	Item name
negated	True if matching is negated (return the opposite of match in public methods), false otherwise

References name(), and negated().

Referenced by MatchingItemList::append(), MatchingItemList::append(), MatchingItemList::at(), MatchingItemList::change(), copy(), MatchingItemList::copy(), MatchingItemRandom::copy(), MatchingItemRegexp::copy(), MatchingItemString::copy(), MatchingItemList::find(), MatchingItemList::insert(), MatchingItemCustom::MatchingItemCustom(), MatchingItemList::MatchingItemList(), MatchingItemRandom::MatchingItemRandom(), MatchingItemRegexp::MatchingItemRegexp(), MatchingItemRegexp::MatchingItemRegexp(), MatchingItemString::MatchingItemString(), MatchingItemList::optimize(), and MatchingItemList::set().

Member Function Documentation

copy()

virtual MatchingItemBase * copy ( ) const

inlinevirtual

Copy this item

Returns

MatchingItemBase pointer, NULL if not implemented

Reimplemented in MatchingItemList, MatchingItemRandom, MatchingItemRegexp, and MatchingItemString.

References MatchingItemBase().

dump()

virtual String & dump ( String & buf, const MatchingItemDump * dump = 0, const String & indent = String::empty(), const String & origIndent = String::empty(), unsigned int depth = 0 ) const

inlinevirtual

Dump this item

Parameters

buf	Destination buffer
indent	Indent for each item (line). Increased by 'origIndent' when depth advances
origIndent	Original indent
dump	Optional dumper
depth	Re-enter depth

Returns

Destination buffer reference

References dump(), and String::empty().

Referenced by dump(), dumpValue(), and dumpXml().

dumpValue()

virtual String & dumpValue ( String & buf, const MatchingItemDump * dump = 0, const String & indent = String::empty(), const String & origIndent = String::empty(), unsigned int depth = 0 ) const

inlinevirtual

Dump this item's value

Parameters

buf	Destination buffer
dump	Optional dumper
indent	Indent for each item (line). Increased by 'origIndent' when depth advances
origIndent	Original indent
depth	Re-enter depth

Returns

Destination buffer reference

References dump(), and String::empty().

dumpXml()

virtual GenObject * dumpXml ( const MatchingItemDump * dump = 0, unsigned int depth = 0 ) const

inlinevirtual

Dump this item in XML format

Parameters

dump	Optional dumper
depth	Re-enter depth

Returns

XmlElement pointer, NULL if not dumped

References dump(), and GenObject::GenObject().

itemCustom()

virtual const MatchingItemCustom * itemCustom ( ) const

inlinevirtual

Check if this item is a MatchingItemCustom one

Returns

MatchingItemCustom pointer

Reimplemented in MatchingItemCustom.

itemList()

virtual const MatchingItemList * itemList ( ) const

inlinevirtual

Check if this item is a MatchingItemList one

Returns

MatchingItemList pointer, NULL if this item is not a MatchingItemList

Reimplemented in MatchingItemList.

itemRandom()

virtual const MatchingItemRandom * itemRandom ( ) const

inlinevirtual

Check if this item is a MatchingItemRandom one

Returns

MatchingItemRandom pointer

Reimplemented in MatchingItemRandom.

itemRegexp()

virtual const MatchingItemRegexp * itemRegexp ( ) const

inlinevirtual

Check if this item is a MatchingItemRegexp one

Returns

MatchingItemRegexp pointer, NULL if this item is not a MatchingItemRegexp

Reimplemented in MatchingItemRegexp.

itemString()

virtual const MatchingItemString * itemString ( ) const

inlinevirtual

Check if this item is a MatchingItemString one

Returns

MatchingItemString pointer, NULL if this item is not a MatchingItemString

Reimplemented in MatchingItemString.

matchListParam()

bool matchListParam ( const NamedList & list, MatchingParams * params = 0 ) const

inline

NamedList parameter match. Handles matching result negation

Parameters

list	List to search for parameter match
params	Optional parameters used during match

Returns

True if matches, false otherwise

References runMatchListParam().

matchString()

bool matchString ( const String & str, MatchingParams * params = 0 ) const

inline

String match. Handles matching result negation

Parameters

str	String to match
params	Optional parameters used during match

Returns

True if matches, false otherwise

References runMatchString().

name()

const String & name ( ) const

inline

Retrieve the name of this item

Returns

Item name

Referenced by MatchingItemRegexp::build(), MatchingItemRandom::copy(), MatchingItemRegexp::copy(), MatchingItemString::copy(), MatchingItemList::find(), MatchingItemList::indexOf(), MatchingItemBase(), MatchingItemCustom::MatchingItemCustom(), MatchingItemList::MatchingItemList(), MatchingItemRandom::MatchingItemRandom(), MatchingItemRegexp::MatchingItemRegexp(), MatchingItemRegexp::MatchingItemRegexp(), MatchingItemString::MatchingItemString(), runMatchListParam(), MatchingItemRandom::runMatchListParam(), and toString().

negated()

bool negated ( ) const

inline

Check if this item is negated when testing

Returns

True if negated, false otherwise

Referenced by MatchingItemRegexp::build(), MatchingItemRandom::copy(), MatchingItemRegexp::copy(), MatchingItemString::copy(), MatchingItemBase(), MatchingItemCustom::MatchingItemCustom(), MatchingItemList::MatchingItemList(), MatchingItemRandom::MatchingItemRandom(), MatchingItemRegexp::MatchingItemRegexp(), MatchingItemRegexp::MatchingItemRegexp(), and MatchingItemString::MatchingItemString().

runMatchListParam()

virtual bool runMatchListParam ( const NamedList & list, MatchingParams * params = 0 ) const

inlinevirtual

NamedList parameter match

Parameters

list	List to search for parameter match
params	Optional parameters used during match

Returns

True if matches, false otherwise

Reimplemented in MatchingItemList, and MatchingItemRandom.

References name(), and runMatchString().

Referenced by matchListParam().

runMatchString()

virtual bool runMatchString ( const String & str, MatchingParams * params = 0 ) const

inlinevirtual

String match to be implemented by descendants

Parameters

str	String to match
params	Optional parameters used during match

Returns

False

Reimplemented in MatchingItemList, MatchingItemRandom, MatchingItemRegexp, and MatchingItemString.

Referenced by matchString(), and runMatchListParam().

toString()

virtual const String & toString ( ) const

inlinevirtual

Retrieve item name (suitable for list retrieval)

Returns

Item name

Reimplemented from GenObject.

References name().

---

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

• yateclass.h