The abstract generic factory for creating arbitrary instances requiring up to two arguments. Use a container type such as Tuple or struct as second parameter type TIn2 if more parameters are required. More...

Collaboration diagram for Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >:

Public Member Functions
IEnumerable< Type >	GetInterfaces ()
	Returns an IEnumerable<Type> of the interfaces supported by the factory instance. More...

IEnumerable< Type >	GetParameters ()
	Returns an IEnumerable<Type> of the generic parameters that constructed the base-factory instance. More...

abstract TInstance	Create (TIn1 parameter)
	Abstract method for creating instances of TInstance defined only through parameter More...

abstract TInstance	Create (TIn1 parameter, TIn2 parameter2=default(TIn2))
	Abstract method for creating instances of TInstance defined only through parameter and parameter2 More...

override string	ToString ()
	Returns a string representation of the Factory type. More...

Static Protected Member Functions
static object	Instantiate (Type type, params object[] parameters)
	Internal method for object instantiation by a passed type type More...

static bool	TryInstantiate (Type type, out object instance, params object[] parameters)
	Internal method for object instantiation following the "Try" convention of returning a bool `true` upon success and passing the result with `out` More...

static TOut	Instantiate< TOut > (Type type, Type[] parameters, params object[] args)
	Internal method object instantiation of a generic type , with the generic-parameters passed as the second argument More...

static TOut	Instantiate< TOut > (Type type, object[] args=null)
	Creates an instance of the type designated by the specified generic type parameter More...

Properties
string	Name `[get]`
	Gets a string representation of the Base-Factory using ToString() More...

Detailed Description

The abstract generic factory for creating arbitrary instances requiring up to two arguments. Use a container type such as Tuple or struct as second parameter type TIn2 if more parameters are required.

Template Parameters

TInstance	The Type of the instances to create and return by the factory method Create(TIn1) and Create(TIn1, TIn2).
TIn1	The parameter type used for defining the instance creation process in the factory method Create(TIn1)
TIn2	The 2. parameter type used for defining the instance creation process in the factory method Create(TIn1) and Create(TIn1, TIn2)

Type Constraints

TInstance

:

class

Definition at line 30 of file Factory.cs.

Member Function Documentation

abstract TInstance Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.Create ( TIn1 parameter )

pure virtual

Abstract method for creating instances of TInstance defined only through parameter

Parameters

parameter The parameter to define the instance creation process

Returns: an instance of Type TInstance

Here is the caller graph for this function:

abstract TInstance Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.Create	(	TIn1	parameter,
		TIn2	parameter2 = `default(TIn2)`
	)

pure virtual

Abstract method for creating instances of TInstance defined only through parameter and parameter2

Parameters

parameter	The parameter to define the instance creation process
parameter2	The 2. parameter to define the instance creation process

Returns: an instance of Type TInstance

IEnumerable<Type> Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.GetInterfaces ( )

Returns an IEnumerable<Type> of the interfaces supported by the factory instance.

Definition at line 46 of file Factory.cs.

         {
             var type = this.GetType();
             yield return type;
 
             foreach(var interfaceType in type.GetTypeInfo().ImplementedInterfaces)
             {
                 yield return interfaceType;
             }
         }

IEnumerable<Type> Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.GetParameters ( )

Returns an IEnumerable<Type> of the generic parameters that constructed the base-factory instance.

Definition at line 60 of file Factory.cs.

         {
             var type = this.GetType();
             yield return type;
 
             foreach(var parameterType in type.GetTypeInfo().GenericTypeParameters)
             {
                 yield return parameterType;
             }
         }

static object Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.Instantiate	(	Type	type,
		params object[]	parameters
	)

staticprotected

Internal method for object instantiation by a passed type type

Parameters

type	the type of the class or struct which to instance
parameters	the parameters passed to the constructor of the class or struct

Returns: Returns an instance object of type TOut or null

Definition at line 93 of file Factory.cs.

         {
             return Instantiate<object>(type: type, args: parameters);
         }

static TOut Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.Instantiate< TOut >	(	Type	type,
		Type[]	parameters,
		params object[]	args
	)

staticprotected

Internal method object instantiation of a generic type , with the generic-parameters passed as the second argument

Template Parameters

TOut	The type of the instance to pass out

Parameters

type	The type of the class or struct which to instance
parameters	the generic types that comprise the generic type
args	The parameters passed to the constructor of the class or struct

Returns: Returns an instance object of type TOut or null

Definition at line 125 of file Factory.cs.

         {
             var constructed = type.GetTypeInfo().MakeGenericType(parameters);
             var instance = Instantiate<TOut>(type: constructed, args: args);
             return instance;
         }

static TOut Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.Instantiate< TOut >	(	Type	type,
		object[]	args = `null`
	)

staticprotected

Creates an instance of the type designated by the specified generic type parameter

Parameters

type	The type of the class or struct which to instance
args	the parameters passed to the constructor of the class or struct

Returns: A reference to the newly created object.

Exceptions

System.MissingMethodException NoteIn the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, System.MissingMemberException, instead. The type that specified for T does not have a parameterless constructor.

Centralize all runtime calls to

<tt>Activator.Create(...)</tt>

and

constructor.Invoke(...)`

Definition at line 141 of file Factory.cs.

         {
             if(args?.Length == 0)
             {
                 return (TOut)Activator.CreateInstance(type);
             }
             return (TOut)Activator.CreateInstance(type, args);
         }

override string Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.ToString ( )

Returns a string representation of the Factory type.

Definition at line 153 of file Factory.cs.

         {
             var type = this.GetType().GetTypeInfo();
             var genericArgs = type.GenericTypeArguments;
             if(genericArgs.Any())
             {
                 var typeNames = genericArgs.Select(t => t.Name)
                     .Aggregate((a, b) => a + ',' + b);
                 return $"{type.Name} <{typeNames}>";
             }
             else
             {
                 return type.Name;
             }
         }

static bool Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.TryInstantiate	(	Type	type,
		out object	instance,
		params object[]	parameters
	)

staticprotected

Internal method for object instantiation following the "Try" convention of returning a bool true upon success and passing the result with out

Parameters

type	The type of the class or struct which to instance
parameters	The parameters passed to the constructor of the class or struct
instance	The assigned instance reference upon instancing of type TOut or `null` upon failure

Returns: Returns bool true upon success or false upon failure and assigning null to instance

Definition at line 105 of file Factory.cs.

         {
             instance = null;
             try { 
                 instance = Instantiate<object>(type: type, args: parameters);
             } catch(Exception)
             {
                 return false;
             }
             return true;
         }

Property Documentation

string Core.TypeCast.Base.Factory< TInstance, TIn1, TIn2 >.Name

get

Gets a string representation of the Base-Factory using ToString()

Definition at line 36 of file Factory.cs.

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

TypeCast/Base/Factory.cs

Public Member Functions

Static Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation