Metalama 1.0 / / Metalama Documentation / Aspect API / Metalama.​Framework.​Advising / IAdvice­Factory / Introduce­Indexer

Method IntroduceIndexer

IntroduceIndexer(INamedType, IType, String, String, IntroductionScope, OverrideStrategy, Action<IIndexerBuilder>, Object, Object)

Introduces an indexer to the target type, or overrides the implementation of an existing one, by specifying individual template methods for each accessor.

Declaration
IIntroductionAdviceResult<IIndexer> IntroduceIndexer(INamedType targetType, IType indexType, string getTemplate, string setTemplate, IntroductionScope scope, OverrideStrategy whenExists, Action<IIndexerBuilder> buildIndexer = null, object args = null, object tags = null)
Parameters
Type Name Description
INamedType targetType

The type into which the indexer must be introduced.

IType indexType

The type of the initial index parameter.

String getTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null the introduced indexer should not have a getter. This method must be annotated with TemplateAttribute. The signature of this method must be T Get() where T is either dynamic or a type compatible with the type of the indexer.

String setTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null if the introduced indexer should not have a setter. This method must be annotated with TemplateAttribute. The signature of this method must be void Set(T value where T is either dynamic or a type compatible with the type of the indexer.

IntroductionScope scope

Determines the scope (e.g. Instance or Static) of the introduced indexer. The default scope depends on the scope of the template accessors. If the accessors are static, the introduced indexer is static. However, if the template accessors are non-static, then the introduced indexer copies of the scope of the target declaration of the aspect.

OverrideStrategy whenExists

Determines the implementation strategy when a indexer of the same name is already declared in the target type. The default strategy is to fail with a compile-time error.

Action<IIndexerBuilder> buildIndexer
Object args

An object (typically of anonymous type) whose properties map to parameters or type parameters of the template methods.

Object tags

An optional opaque object of anonymous type passed to the template method and exposed under the Tags property of the meta API.

Returns
Type Description
IIntroductionAdviceResult<IIndexer>

An IIndexerBuilder that allows to dynamically change the name or type of the introduced indexer.

See Also

IntroduceIndexer(INamedType, Type, String, String, IntroductionScope, OverrideStrategy, Action<IIndexerBuilder>, Object, Object)

Introduces an indexer to the target type, or overrides the implementation of an existing one, by specifying individual template methods for each accessor.

Declaration
IIntroductionAdviceResult<IIndexer> IntroduceIndexer(INamedType targetType, Type indexType, string getTemplate, string setTemplate, IntroductionScope scope, OverrideStrategy whenExists, Action<IIndexerBuilder> buildIndexer = null, object args = null, object tags = null)
Parameters
Type Name Description
INamedType targetType

The type into which the indexer must be introduced.

Type indexType

The type of the initial index parameter.

String getTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null the introduced indexer should not have a getter. This method must be annotated with TemplateAttribute. The signature of this method must be T Get() where T is either dynamic or a type compatible with the type of the indexer.

String setTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null if the introduced indexer should not have a setter. This method must be annotated with TemplateAttribute. The signature of this method must be void Set(T value where T is either dynamic or a type compatible with the type of the indexer.

IntroductionScope scope

Determines the scope (e.g. Instance or Static) of the introduced indexer. The default scope depends on the scope of the template accessors. If the accessors are static, the introduced indexer is static. However, if the template accessors are non-static, then the introduced indexer copies of the scope of the target declaration of the aspect.

OverrideStrategy whenExists

Determines the implementation strategy when a indexer of the same name is already declared in the target type. The default strategy is to fail with a compile-time error.

Action<IIndexerBuilder> buildIndexer
Object args

An object (typically of anonymous type) whose properties map to parameters or type parameters of the template methods.

Object tags

An optional opaque object of anonymous type passed to the template method and exposed under the Tags property of the meta API.

Returns
Type Description
IIntroductionAdviceResult<IIndexer>

An IIndexerBuilder that allows to dynamically change the name or type of the introduced indexer.

See Also

IntroduceIndexer(INamedType, IReadOnlyList<(IType, String)>, String, String, IntroductionScope, OverrideStrategy, Action<IIndexerBuilder>, Object, Object)

Introduces an indexer to the target type, or overrides the implementation of an existing one, by specifying individual template methods for each accessor.

Declaration
IIntroductionAdviceResult<IIndexer> IntroduceIndexer(INamedType targetType, IReadOnlyList<(IType, string)> indices, string getTemplate, string setTemplate, IntroductionScope scope, OverrideStrategy whenExists, Action<IIndexerBuilder> buildIndexer = null, object args = null, object tags = null)
Parameters
Type Name Description
INamedType targetType

The type into which the indexer must be introduced.

IReadOnlyList<(, )<IType, String>> indices

The types and names of the index parameters.

String getTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null the introduced indexer should not have a getter. This method must be annotated with TemplateAttribute. The signature of this method must be T Get() where T is either dynamic or a type compatible with the type of the indexer.

String setTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null if the introduced indexer should not have a setter. This method must be annotated with TemplateAttribute. The signature of this method must be void Set(T value where T is either dynamic or a type compatible with the type of the indexer.

IntroductionScope scope

Determines the scope (e.g. Instance or Static) of the introduced indexer. The default scope depends on the scope of the template accessors. If the accessors are static, the introduced indexer is static. However, if the template accessors are non-static, then the introduced indexer copies of the scope of the target declaration of the aspect.

OverrideStrategy whenExists

Determines the implementation strategy when a indexer of the same name is already declared in the target type. The default strategy is to fail with a compile-time error.

Action<IIndexerBuilder> buildIndexer
Object args

An object (typically of anonymous type) whose properties map to parameters or type parameters of the template methods.

Object tags

An optional opaque object of anonymous type passed to the template method and exposed under the Tags property of the meta API.

Returns
Type Description
IIntroductionAdviceResult<IIndexer>

An IIndexerBuilder that allows to dynamically change the name or type of the introduced indexer.

See Also

IntroduceIndexer(INamedType, IReadOnlyList<(Type, String)>, String, String, IntroductionScope, OverrideStrategy, Action<IIndexerBuilder>, Object, Object)

Introduces an indexer to the target type, or overrides the implementation of an existing one, by specifying individual template methods for each accessor.

Declaration
IIntroductionAdviceResult<IIndexer> IntroduceIndexer(INamedType targetType, IReadOnlyList<(Type, string)> indices, string getTemplate, string setTemplate, IntroductionScope scope, OverrideStrategy whenExists, Action<IIndexerBuilder> buildIndexer = null, object args = null, object tags = null)
Parameters
Type Name Description
INamedType targetType

The type into which the indexer must be introduced.

IReadOnlyList<(, )<Type, String>> indices

The types and names of the index parameters.

String getTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null the introduced indexer should not have a getter. This method must be annotated with TemplateAttribute. The signature of this method must be T Get() where T is either dynamic or a type compatible with the type of the indexer.

String setTemplate

The name of the method of the aspect class whose type and implementation will be used as a template for the getter, or null if the introduced indexer should not have a setter. This method must be annotated with TemplateAttribute. The signature of this method must be void Set(T value where T is either dynamic or a type compatible with the type of the indexer.

IntroductionScope scope

Determines the scope (e.g. Instance or Static) of the introduced indexer. The default scope depends on the scope of the template accessors. If the accessors are static, the introduced indexer is static. However, if the template accessors are non-static, then the introduced indexer copies of the scope of the target declaration of the aspect.

OverrideStrategy whenExists

Determines the implementation strategy when a indexer of the same name is already declared in the target type. The default strategy is to fail with a compile-time error.

Action<IIndexerBuilder> buildIndexer
Object args

An object (typically of anonymous type) whose properties map to parameters or type parameters of the template methods.

Object tags

An optional opaque object of anonymous type passed to the template method and exposed under the Tags property of the meta API.

Returns
Type Description
IIntroductionAdviceResult<IIndexer>

An IIndexerBuilder that allows to dynamically change the name or type of the introduced indexer.

See Also