interface IConfiguratorEnum in Tinman.Core.Config.Binding

interface	IConfiguratorEnum	with	<T>
		extends	IConfigurator<T>
		base of	ConfiguratorEnum

Attributes

Type

Returns the configuration type of this configurator.

property	Type { get }
type	ConfigType
value	[not-null]	The configuration type.
inherited	IConfiguratorBase.Type

Methods

DefaultItem

Adds an enum item as the default item.

method	DefaultItem (string name, T value, string tag = null)
params	name	[not-empty]	The enum item name.
	value		The enum item value.
	tag		Optional enum item string tag. Defaults to null.

Finish

Finishes building of this enum configurator.

method	Finish (bool sort = false, bool defaultFirst = false)
type	IConfiguratorEnum<T>
params	sort		Sort enum items by their name?
	defaultFirst		Place default item first?
returns		[not-null]	this

Flags

Applies the given flag semantic to this configurator.

method	Flags (IFlags<T> handler)
type	IConfigurator<T>
params	handler	[not-null]	The flag semantic.
returns		[not-null]	The resulting configurator.

Remarks:

This configurator must be finished first.

FromField

Creates a new instance from a field of the given configuration value.

[OwnerReturn]
method	FromField (ConfigValue config, string field)
type	T
params	config	[not-null]	The configuration value.
	field	[not-null]	Field name.
returns		[not-null]	The created instance.
inherited	IConfigurator.FromField

FromScript

Creates a new instance from the given configuration entity.

[OwnerReturn]
method	FromScript (ConfigScript script, string name)
type	T
params	script	[not-null]	The config script.
	name	[not-null]	Name of the entity.
returns		[not-null]	The created instance.
inherited	IConfigurator.FromScript

FromValue

Creates a new instance from the given configuration value.

[OwnerReturn]
method	FromValue (ConfigValue config)
type	T
params	config	[not-null]	The configuration value.
returns		[not-null]	The created instance.
inherited	IConfigurator.FromValue

FromValueArray

Creates an array of instances from the given configuration value.

[OwnerReturn]
method	FromValueArray (ConfigValue config)
type	T[]
params	config	[not-null]	The configuration value.
returns			The resulting array or null if config contains zero elements.
inherited	IConfigurator.FromValueArray

FromValueList

Creates an array of instances from the given configuration value.

[OwnerReturn]
method	FromValueList (ConfigValue config)
type	IVector<T>
params	config	[not-null]	The configuration value.
returns			The resulting array or null if config contains zero elements.
inherited	IConfigurator.FromValueList

Item

Adds an enum item.

method	Item (string name, T value, string tag = null)
params	name	[not-empty]	The enum item name.
	value		The enum item value.
	tag		Optional enum item string tag. Defaults to null.

PleaseIncludeInBinaryThanks

This is a no-op method that forces the compiler / linker to include this type in the resulting binary.

method	PleaseIncludeInBinaryThanks ()
inherited	IPleaseIncludeInBinaryThanks.PleaseIncludeInBinaryThanks

Remarks:

Calling this stub method makes sure that all lazy constructor calls have been made.

To initialize everything, an application needs to call this method on its root module(s) (see TinmanModule), followed by a call to PleaseIncludeInBinaryThanksAll.

ToValue

Returns the configuration value that describes the given object.

method	ToValue (T instance)
type	ConfigValue
params	instance		The object.
returns		[not-null]	The configuration value.
inherited	IConfigurator.ToValue

Remarks:

The returned value may be of type Invalid, which means that the given object in its current state cannot be described with the configuration API.

ToValueArray

Returns the configuration value that describes the given objects.

method	ToValueArray (T[] instances)
type	ConfigValue
params	instances		The object.
returns		[not-null]	The configuration array value.
inherited	IConfigurator.ToValueArray

Remarks:

The returned value may be of type Invalid, which means that the given object in its current state cannot be described with the configuration API.

ToValueList

Returns the configuration value that describes the given objects.

method	ToValueList (IVectorConst<T> instances)
type	ConfigValue
params	instances		The object.
returns		[not-null]	The configuration array value.
inherited	IConfigurator.ToValueList

Remarks:

The returned value may be of type Invalid, which means that the given object in its current state cannot be described with the configuration API.