class ConfigValueBag in Tinman.Core.Config

Default implementation of the IConfigValueBag interface.

sealed class

ConfigValueBag

implements

IConfigValueBag

Public / Attributes

Count

The number of named objects in the bag.

public property	Count { get }
type	int32
value	[>=0]	The number of named objects.
implements	IConfigTypeBag.Count

Names

The names of all objects in the bag.

public property	Names { get }
type	IBagConst<string>
value	[not-null]	The object names.
implements	IConfigTypeBag.Names

Version

Returns the current version of object.

public property	Version { get }
type	int32
value		The current version number.
implements	IVersioned.Version

Remarks:

For each modification, the version is incremented by at least one.

Public / Constructors

ConfigValueBag

public constructor	ConfigValueBag (IConfigValueBag parent = null)
params	parent

Public / Methods

Clear

Removes all entries from this bag.

public method

Clear ()

Contains

Checks if this bag contains an object of the given name.

public method	Contains (string name)
type	bool
params	name	[not-null]	The name.
returns			true if the bag contains an object named name, false if it does not.
implements	IConfigTypeBag.Contains

GetDomain

Looks in the config domain of this bag and tries to find the bag of the given name.

public method	GetDomain (string name)
type	IConfigValueBag
params	name		Name of the bag to find or null to return this bag.
returns		[not-null]	The type bag. Will be empty if not found.
implements	IConfigTypeBag.GetDomain

GetMemberNull

Returns the ConfigMember which corresponds to the given named config object.

public method	GetMemberNull (string name)
type	ConfigMember
params	name	[not-null]	The name.
returns			The ConfigMember or null.
implements	IConfigValueBag.GetMemberNull

GetTypeNull

Returns the config type that is associated with the given name, for example the type of a script variable.

public method	GetTypeNull (string name)
type	ConfigType
params	name	[not-null]	The name.
returns			The associated config type of null if not found.
implements	IConfigTypeBag.GetTypeNull

GetValueNull

Returns the config value that has the given name.

public method	GetValueNull (string name, ConfigValue[] arguments = null)
type	ConfigValue
params	name	[not-null]	The name.
	arguments		Optional arguments for function call. If null, a field value is accessed. When not null, a function call is performed. Defaults to null.
returns			The object or null if there is no object named name.
implements	IConfigValueBag.GetValueNull

Put

Puts a new entry into this bag, removing any existing ones.

public method	Put (string key, ConfigValue value)
params	key	[not-empty]	The entry name.
	value	[not-null]	The entry value.
returns			The previous entry value (if any) or null.

Remove

Removes an entry from this bag.

public method	Remove (string key)
params	key	[not-empty]	The entry name.
returns			The removed entry value (if any) or null.