Core.TypeCast.ConverterCollection.AddBuilder< TBase > Class Template Reference

Allows to perform a deferred adding operation of multiple adds using a common Base-Class Type argument, common ConverterCollectionSettings as well as a mutual CancellationToken for the added group of converters. The operation is applied upon invoking End, and can be explicitly canceled by invoking Cancel More...

Collaboration diagram for Core.TypeCast.ConverterCollection.AddBuilder< TBase >:

Public Member Functions
	AddBuilder (ConverterCollection converterCollection, ConverterCollectionSettings settings=null, CancellationToken cancellationToken=default(CancellationToken))
	Creates a new instance of AddBuilder<TBase> for grouped-adding of converter-functions with default arguments defined in the constructor More...
	AddBuilder (ConverterCollection converterCollection, ConverterCollectionSettings settings, ref CancellationToken cancellationToken)
	Creates a new instance of AddBuilder<TBase> for grouped-adding of converter-functions with mutual arguments defined in the constructor More...
AddBuilder< TBase >	Add< TIn, TOut > (Func< TIn, TOut > converterAction)
	Creates and adds a Converter instance to the collection of ConverterCollection.Items using a Delegate More...
AddBuilder< TBase >	Add< TIn, TOut > (Func< TIn, TOut, TOut > converterActionDefault)
	Creates and adds a Converter instance to the collection of ConverterCollection.Items using a Delegate More...
IConverterCollection	Cancel ()
	Dummy function to explicitly end the current chained builder operation without applying any deferred calls and clear any resources More...
IConverterCollection	End ()
	End the deferred adding operation by invocation the deferred list of actions More...

Detailed Description

Allows to perform a deferred adding operation of multiple adds using a common Base-Class Type argument, common ConverterCollectionSettings as well as a mutual CancellationToken for the added group of converters. The operation is applied upon invoking End, and can be explicitly canceled by invoking Cancel

Template Parameters

TBase

The declaring, attributed Type of the converter-functions to add as a group.

Type Constraints

TBase

:

class

Definition at line 45 of file ConverterCollection.AddBuilder.cs.

Constructor & Destructor Documentation

Core.TypeCast.ConverterCollection.AddBuilder< TBase >.AddBuilder	(	ConverterCollection	converterCollection,
		ConverterCollectionSettings	settings = null,
		CancellationToken	cancellationToken = default(CancellationToken)
	)

Creates a new instance of AddBuilder<TBase> for grouped-adding of converter-functions with default arguments defined in the constructor

Parameters

converterCollection	A reference to the ConverterCollection instance
settings	A reference to an optional ConverterCollectionSettings instance to be applied only for the group of converter-functions
cancellationToken	An optional value-instance to the mutual CancellationToken

Definition at line 75 of file ConverterCollection.AddBuilder.cs.

                : this(converterCollection: converterCollection, settings: settings, cancellationToken: ref cancellationToken)
            {

            }

Core.TypeCast.ConverterCollection.AddBuilder< TBase >.AddBuilder	(	ConverterCollection	converterCollection,
		ConverterCollectionSettings	settings,
		ref CancellationToken	cancellationToken
	)

Creates a new instance of AddBuilder<TBase> for grouped-adding of converter-functions with mutual arguments defined in the constructor

Parameters

converterCollection	A reference to the ConverterCollection instance
settings	A reference to an optional ConverterCollectionSettings instance to be applied only for the group of converter-functions
cancellationToken	An optional reference to the mutual CancellationToken

Definition at line 91 of file ConverterCollection.AddBuilder.cs.

            {
                this.baseClass = converterCollection;
                this.settings = settings;
                this.cancellationToken = cancellationToken;
                this.actions = new List<Action>();
            }

Member Function Documentation

AddBuilder<TBase> Core.TypeCast.ConverterCollection.AddBuilder< TBase >.Add< TIn, TOut >

(

Func< TIn, TOut >

converterAction

)

Creates and adds a Converter instance to the collection of ConverterCollection.Items using a Delegate

Template Parameters

TIn	The Source- / From- Typefrom which to Converter<TIn,TOut>.Convert(object,object)
TOut	The Target / To- Type to which to Converter<TIn,TOut>.Convert(object,object)

Parameters

converterAction	A function delegate Func<TIn, TOut> to use as the Converter.Function
cancellationToken	Optional token to propagate notification that operations should be canceled. From System.Threading.Tasks.

Returns

Returns a (nested-class) instance of AddBuilder<TBase> with strongly-typed generic methods for deferred grouped-adding.

Exceptions

ConverterException

Throws a ConverterCause.ConverterCollectionAddFailed with a wrapped Exception.InnerException if an internal error occurred

Definition at line 111 of file ConverterCollection.AddBuilder.cs.

            {
                actions.Add(() => this.baseClass.Add<TIn, TOut, TBase>(converterAction, this.cancellationToken));
                return this;
            }

AddBuilder<TBase> Core.TypeCast.ConverterCollection.AddBuilder< TBase >.Add< TIn, TOut >

(

Func< TIn, TOut, TOut >

converterActionDefault

)

Creates and adds a Converter instance to the collection of ConverterCollection.Items using a Delegate

Template Parameters

TIn	The Source- / From- Typefrom which to Converter<TIn,TOut>.Convert(object,object)
TOut	The Target / To- Type to which to Converter<TIn,TOut>.Convert(object,object)

Parameters

converterActionDefault	A function delegate Func<TIn, TOut, TOut> to use as the Converter.Function
cancellationToken	Optional token to propagate notification that operations should be canceled. From System.Threading.Tasks.

Returns

Returns a (nested-class) instance of AddBuilder<TBase> with strongly-typed generic methods for deferred grouped-adding.

Exceptions

ConverterException

Throws a ConverterCause.ConverterCollectionAddFailed with a wrapped Exception.InnerException if an internal error occurred

Definition at line 127 of file ConverterCollection.AddBuilder.cs.

            {
                actions.Add(() => this.baseClass.Add<TIn, TOut, TBase>(converterActionDefault, this.cancellationToken));
                return this;
            }

IConverterCollection Core.TypeCast.ConverterCollection.AddBuilder< TBase >.Cancel

(

)

Dummy function to explicitly end the current chained builder operation without applying any deferred calls and clear any resources

Returns

Returns a IConverterCollection for safe, constricted function chaining.

Definition at line 137 of file ConverterCollection.AddBuilder.cs.

            {
                return baseClass;
            }

IConverterCollection Core.TypeCast.ConverterCollection.AddBuilder< TBase >.End

(

)

End the deferred adding operation by invocation the deferred list of actions

Returns

Returns a IConverterCollection for safe, constricted function chaining.

Definition at line 146 of file ConverterCollection.AddBuilder.cs.

            {
                // temporarily switch out settings for any passed builder-settings argument
                if(this.settings != null)
                {
                    var tmp = this.baseClass.Settings;
                    this.baseClass.Settings = this.settings;
                    actions.Add(() => this.baseClass.Settings = tmp);
                }
                actions.Count(a => { a.Invoke(); return true; });
                return baseClass;
            }

---

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

• TypeCast/ConverterCollection.AddBuilder.cs