Core.TypeCast Namespace Reference

Namespaces
namespace	Base
namespace	Converters

Classes
class	Converter
	The generic, strictly-typed converter class, for type casting and simple conversions. More...
class	ConverterAttribute
	Use ConverterAttribute to declare a class as a logical Type Converter. As such the only contingent declaration contract requirement is adherence to implement a public constructor which takes a IConverterCollection collection parameter More...
class	ConverterCollection
	The thread-safe, static collection of Converter items, using Core.Singleton and supporting Core.Singleton.ISingleton More...
class	ConverterCollectionException
	The Exception-type which is raised exclusively by the Converter<T> Library More...
class	ConverterCollectionFilters
	A set of IQueryable<Converter> extension methods for filtering ConverterCollection items using System.Linq
class	ConverterCollectionLookup
	A set of IQueryable<Converter> extension methods for filtering ConverterCollection items using System.Linq
class	ConverterCollectionSettings
	The settings for the ConverterCollection. More...
class	ConverterException
	The Exception-type which is raised exclusively by the Converter<TIn,TOut> Library More...
class	ConverterExtension
	The Converter extension methods
class	ConverterMethodAttribute
	Use ConverterMethodAttribute to declare a method in an arbitrary class as a logical Converter function. The only restriction towards the attributed method is a maximum of two defined function parameters. This limitation is by design, to advocate the use of the single responsibility principle, and building complex converters out of smaller ones, as implemented by a different library. Take a look at the examples and documentation for more information. More...
struct	ConverterParameters
	Container with sequentially assigned type-parameters of a strictly typed Converter-Function, in the sequence of Types for: In, Out, Argument More...
class	DependencyInjectionException
	The Exception-type which is raised exclusively by the DependencyInjection<TDependency> class More...
interface	IConvertContext
	The common IConvertContext interface. More...
interface	IConverter
	The Base Converter interface. More...
interface	IConverterCollection
interface	IException
	The common Exceptioninterface. More...
interface	IFactory
	The generic, common factory interface for declaring factories creating arbitrary object instances requiring up to two arguments. Use a container type such as Tuple or struct as second parameter TIn2 if more parameters are required. More...
interface	IRepository
	The base repository interface More...
interface	IRepositoryEnumerable
	The generic repository interface with one lookup identifier More...
class	ObjectExtension
	The object extension methods to convert an object of an unrestricted unknown type TIn to an unrestricted known type TOut.

Enumerations
enum	ConverterCause : ulong {   ConverterCause.None = 0,   ConverterCause.Unknown = 1 << 0,   ConverterCause.Default = 1 << 1,   ConverterCause.ConverterFunctionNull = 1 << 2,   ConverterCause.ConverterArgumentNull = 1 << 3,   ConverterCause.ConverterArgumentGenericType = 1 << 4,   ConverterCause.ConverterArgumentWrongType = 1 << 5,   ConverterCause.ConverterExists = 1 << 6,   ConverterCause.ConvertFailed = 1 << 7,   ConverterCause.ConverterWrapperError = 1 << 8,   ConverterCause.InternalError = 1 << 9,   ConverterCause.ConstructorInjectionNull = 1 << 10,   ConverterCause.ConverterCollectionAddFailed = 1 << 11,   ConverterCause.InstanceRequiresParameters = 1 << 12,   ConverterCause.ConverterNotImplemented = 1 << 13,   ConverterCause.ConverterTypeInIsExplicitObject = 1 << 14,   ConverterCause.ConverterArgumentDelegateTooManyParameters = 1 << 15,   ConverterCause.ConverterArgumentDelegateNoParameters = 1 << 16,   ConverterCause.ConverterAutoInitializationFailed = 1 << 17,   ConverterCause.TransformRequiresEqualInOutTypes = 1 << 18,   ConverterCause.InvalidCast = 1 << 19,   ConverterCause.DelegateArgumentWrongType = 1 << 20,   ConverterCause.LogicError = 1 << 21,   ConverterCause.BadInputFormat = 1 << 21,   ConverterCause.ConverterFunctionDefaultNull = Default | ConverterFunctionNull }
	Contains the reasons for a ConverterException to be raised. More...
enum	ConverterCollectionCause {   ConverterCollectionCause.None = 0,   ConverterCollectionCause.Unknown = 1 << 0,   ConverterCollectionCause.Default = 1 << 1,   ConverterCollectionCause.InternalError = 1 << 2,   ConverterCollectionCause.AddFailed = 1 << 3,   ConverterCollectionCause.CollectionIsNull = 1 << 4,   ConverterCollectionCause.ConverterExists = 1 << 5,   ConverterCollectionCause.ConverterArgumentNull = 1 << 6,   ConverterCollectionCause.ConverterArgumentWrongType = 1 << 7,   ConverterCollectionCause.ConverterClassExists = 1 << 8,   ConverterCollectionCause.InstanceRequiresParameters = 1 << 9,   ConverterCollectionCause.ConverterFunctionsNull = 1 << 10,   ConverterCollectionCause.AddFailedConverterExists = AddFailed | ConverterExists }
	Contains the reasons for a ConverterCollectionException to be raised. More...

---

Class Documentation

class Core::TypeCast::Converter

The generic, strictly-typed converter class, for type casting and simple conversions.

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)

the class is declared sealed as the only converter implementation must be herein and no further implementation must be allowed, to enforce decoupling between arbitrary converter logic with a guaranteed implementation of the underlying converter-container in question

Definition at line 25 of file Converter_2T.cs.

Collaboration diagram for Core.TypeCast.Converter< TIn, TOut >:

struct Core::TypeCast::ConverterParameters

Container with sequentially assigned type-parameters of a strictly typed Converter-Function, in the sequence of Types for: In, Out, Argument

Definition at line 20 of file ConverterParameters.cs.

Collaboration diagram for Core.TypeCast.ConverterParameters:

Class Members
Type	Arg
int	Count
Type	In
Type	Out

interface Core::TypeCast::IRepository

The base repository interface

Implemented by any instantiable object which can provide data by passing an Identifier to facilitate lookup

Definition at line 18 of file IRepository.cs.

Collaboration diagram for Core.TypeCast.IRepository:

interface Core::TypeCast::IRepositoryEnumerable

The generic repository interface with one lookup identifier

Implemented by any instantiable object which can provide data by passing one Identifier to facilitate lookup

@code{cs}
    ConverterCollection.CurrentInstance.Add( (int[] a, IModelWeather model) =>  { 
        ...repo... 
    });
    IRepositoryEnumerable<IModelWeather> repositoryQuery = new []{40420,52000,80801,20030}
                                                                .ConvertTo<IRepositoryEnumerable<IModelWeather>>( modelInstance );
    foreach( var item in repositoryQuery)
    {
        ...
    }
@endcode

Type Constraints

TOut

:

IEnumerable

Definition at line 31 of file IRepositoryEnumerable.cs.

Collaboration diagram for Core.TypeCast.IRepositoryEnumerable< out out TOut >:

Enumeration Type Documentation

enum Core.TypeCast.ConverterCause : ulong

strong

Contains the reasons for a ConverterException to be raised.

Enumerator
None	Indicates the default or unspecified value
Unknown	Indicates an unknown or undefined flag
Default	Indicates a default or normal flag
ConverterFunctionNull	Indicates that the Converter.Function property is not set and null
ConverterArgumentNull	Indicates that the Converter<TIn, TOut> or an passed argument to a Converter method is null
ConverterArgumentGenericType	Indicates a generic input type Converter.From was passed, whilst being explicitly disallowed in the ConverterCollectionSettings instance
ConverterArgumentWrongType	Indicates that a Converter<TIn, TOut> method got passed an argument of a System.TypeT that does not match TIn or TOut respectively
ConverterExists	Indicates that the Converter<TIn, TOut>, defined by the Input and Output conversion Types TIn --> TOut already exists
ConvertFailed	Indicates that the Converter<TIn,TOut>.Convert(object,object) method failed near or at the custom convert Function invocation
ConverterWrapperError	Indicates that the custom converter function wrapper yielded an error See also ConverterExtension.FunctionDefaultWrapper<TIn,TOut>(Core.TypeCast.Base.Converter)
InternalError	Indicates an internal error state that may be specified further in the Exception.InnerException property Can be raised when the Converter's constructor must be explicitly called with parameters
ConstructorInjectionNull	Dependency Injection failed due to a null reference Indicates that a conversion related class constructor was injected with an argument that is null
ConverterCollectionAddFailed	The Converter could not be added to the ConverterCollection The Converter instance was not added to the BlockingCollection<T> ConverterCollection.Items See also ConverterCollection.Add<TIn,TOut>(System.Func<TIn,TOut>,System.Type,System.Threading.CancellationToken)
InstanceRequiresParameters	Indicates that the constructor of a parent Converter<TIn, TOut> class T requires parameters for proper instancing, yet was invoked parameter-less. User-thrown exception in the custom parameter-less constructor of the logical Converter class
ConverterNotImplemented	Indicates that a method in a converter or conversion-related class instance does not possess a logical implementation. Make sure methods marked as virtual are overwritten.
ConverterTypeInIsExplicitObject	Indicates that the conversion source type is set to object, which is not sensible. Omit setting both target type parameters instead
ConverterArgumentDelegateTooManyParameters	Indicates that passed converter function takes too many parameters. A maximum of two is permitted.
ConverterArgumentDelegateNoParameters	Indicates that the passed converter function takes no parameters. At least one up two a maximum of two is required.
ConverterAutoInitializationFailed	Indicates that the reflection of the loading assembly failed, likely due to changes or security fixes for newer portable library class releases
TransformRequiresEqualInOutTypes	Indicates that the source and target types do not match. If they do not match use other functions instead, like CastTo and ConvertTo.
InvalidCast	Indicates that the cast failed, likely due to a missing converter. These exceptions can be suppressed with a function argument.
DelegateArgumentWrongType	Indicates that the argument types of a given delegate do not match the return type and / or types of the provided parameters.
LogicError	Indicates that the converter logic raised an InvalidOperationException, OverflowException or ArithmeticException which was caught.
BadInputFormat	Indicates that the input argument was badly formatted.
ConverterFunctionDefaultNull	Indicates a null-reference for an existing Converter default function Flag Combinations

Definition at line 20 of file ConverterCause.cs.

                               : ulong
    {
        [Description("Indicates the default or unspecified value")]
        None = 0, 

        [Description("Indicates the default or unspecified value")]
        Unknown = 1 << 0, 

        [Description("Indicates the default or unspecified value")]
        Default = 1 << 1, 

        [Description("Indicates that the Converter function is not set and null")]
        ConverterFunctionNull = 1 << 2, 

        [Description("Indicates that the Converter or an passed argument to the converter is `null`")]
        ConverterArgumentNull = 1 << 3, 

        [Description("Indicates a generic input type was passed, whilst being explicitly disallowed in the ConverterCollectionSettings instance")]
        ConverterArgumentGenericType = 1 << 4, 

        [Description("Indicates that a Converter method got passed an argument of a Type `T` that does not match TIn or TOut respectively")]
        ConverterArgumentWrongType = 1 << 5, 

        [Description("Indicates that the Converter, defined by the Input and Output conversion Types TIn --> TOut already exists")]
        ConverterExists = 1 << 6, 

        [Description("Indicates that the convert method failed near or at the custom convert Function invocation ")]
        ConvertFailed = 1 << 7, 

        [Description("Indicates that the custom converter function wrapper yielded an error")]
        ConverterWrapperError = 1 << 8, 

        [Description("Indicates an internal error state that may be specified further in the InnerException property")]
        InternalError = 1 << 9, 

        [Description("Indicates that a conversion related class constructor was injected with an argument that is null")]
        ConstructorInjectionNull = 1 << 10, 

        [Description("The converter could not be added to the ConverterCollection")]
        ConverterCollectionAddFailed = 1 << 11, 

        [Description("Indicates that the constructor of a conversion-related class requires parameters for proper instancing, yet was invoked parameterless.")]
        InstanceRequiresParameters = 1 << 12, 

        [Description("Indicates that a method in a converter or conversion-related class instance does not possess a logical implementation.")]
        ConverterNotImplemented = 1 << 13,

        [Description("Indicates that the conversion source type is set to object, which is not sensible. Omit setting both target type parameters instead")]
        ConverterTypeInIsExplicitObject = 1 << 14,

        [Description("Indicates that passed converter function takes too many parameters. A maximum of two is permitted.")]
        ConverterArgumentDelegateTooManyParameters = 1 << 15,

        [Description("Indicates that the passed converter function takes no parameters. At least one up two a maximum of two is required.")]
        ConverterArgumentDelegateNoParameters = 1 << 16,

        [Description("Indicates that the reflection of the loading assembly failed, likely due to changes or security fixes for newer portable library class releases")]
        ConverterAutoInitializationFailed = 1 << 17,

        [Description("Indicates that the source and target types do not match. If they do not match use other functions instead, like CastTo and ConvertTo.")]
        TransformRequiresEqualInOutTypes = 1 << 18,

        [Description("Indicates that the cast failed, likely due to a missing converter. These exceptions can be suppressed with a function argument.")]
        InvalidCast = 1 << 19,

        [Description("Indicates that the argument types of a given delegate do not match the return type and / or types of the provided parameters.")]
        DelegateArgumentWrongType = 1 << 20,


        [Description("Indicates that the converter logic raised an `InvalidOperationException`, `OverflowException` or `ArithmeticException` which was caught.")]
        LogicError = 1 << 21,

        [Description("Indicates that the input argument was badly formatted.")]
        BadInputFormat = 1 << 21,

        [Description("Indicates a null-reference for an existing Converter default function")]
        ConverterFunctionDefaultNull = Default | ConverterFunctionNull, 
    }

enum Core.TypeCast.ConverterCollectionCause

strong

Contains the reasons for a ConverterCollectionException to be raised.

Enumerator
None	Indicates the default or unspecified value
Unknown	Indicates an unknown or undefined flag
Default	Indicates a default or normal flag
InternalError	Indicates an internal error state that may be specified further in the Exception.InnerException property Can be raised when the Converter's constructor must be explicitly called with parameters
AddFailed	The converter could not be added to the ConverterCollection See also ConverterCollection.Add<TIn,TOut>(System.Func<TIn,TOut>,System.Type,System.Threading.CancellationToken)
CollectionIsNull	Indicates a null reference for the collection argument
ConverterExists	Indicates that the Converter<TIn, TOut>, defined by the Input and Output conversion Types TIn --> TOut already exists
ConverterArgumentNull	Indicates that the Converter<TIn, TOut> or an passed argument to a Converter method is null
ConverterArgumentWrongType	Indicates that a ConverterCollection method got passed an argument of a System.TypeT that does not match TIn or TOut respectively
ConverterClassExists	The custom converter / conversion-related class has already been instantiated and added to the to the ConverterCollection
InstanceRequiresParameters	Indicates that the constructor the ConverterCollection class requires parameters for proper instancing, yet was invoked without parameters. User-thrown exception in the custom parameter-less constructor of the logical Converter class
ConverterFunctionsNull	Indicates that the Converter.Function property and Converter.FunctionDefault is not set to a Delegate and null
AddFailedConverterExists	The converter could not be added to the ConverterCollection because another converter for the specified input/output types already exists Flag Combinations

Definition at line 19 of file ConverterCollectionCause.cs.

    {
        [Description("Indicates the default or unspecified value")]
        None = 0, 

        [Description("Indicates the default or unspecified value")]
        Unknown = 1 << 0, 

        [Description("Indicates the default or unspecified value")]
        Default = 1 << 1, 

        [Description("Indicates an internal error state that may be specified further in the InnerException property")]
        InternalError = 1 << 2, 

        [Description("The converter could not be added to the ConverterCollection")]
        AddFailed = 1 << 3, 

        [Description("Indicates a null reference for the collection argument")]
        CollectionIsNull = 1 << 4, 

        [Description("Indicates that the Converter, defined by the Input and Output conversion Types TIn --> TOut already exists")]
        ConverterExists = 1 << 5,

        [Description("Indicates that the Converter or an passed argument to the converter is `null`")]
        ConverterArgumentNull = 1 << 6,

        [Description("Indicates that a ConverterCollection method got passed an argument of a Type `T` that does not match TIn or TOut respectively")]
        ConverterArgumentWrongType = 1 << 7, 

        [Description("The custom converter / conversion-related class has already been instantiated and added to the to the ConverterCollection")]
        ConverterClassExists = 1 << 8, 

        [Description(
            "Indicates that the constructor the ConverterCollection class requires parameters for proper instancing, yet was invoked without parameters")]
        InstanceRequiresParameters = 1 << 9,

        [Description("Indicates that the Converter function and default-value function is not set to a Delegate and null")]
        ConverterFunctionsNull = 1 << 10,

        [Description("Indicates a Converter already exists for the specified input and output Types and was thus not added to the ConverterCollection")]
        AddFailedConverterExists = AddFailed | ConverterExists, 
    }