Class ConfigAttribute

Specifies how to apply configuration values to classes/fields/props

Inheritance
System.Object
System.Attribute
ConfigAttribute
Inherited Members
System.Attribute.Equals(System.Object)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetHashCode()
System.Attribute.IsDefaultAttribute()
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.Module, System.Type)
System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.Match(System.Object)
System.Attribute.TypeId
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Environment
Assembly: NFX.dll
Syntax
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Struct, Inherited = true, AllowMultiple = false)]
public class ConfigAttribute : Attribute

Constructors

ConfigAttribute()

Decorates members so that path is defaulted from member's name with prepended '$' attribute symbol

Declaration
public ConfigAttribute()

ConfigAttribute(String)

Decorates members that will be configured from supplied path

Declaration
public ConfigAttribute(string path)
Parameters
Type Name Description
System.String path

ConfigAttribute(String, Object)

Decorates members that will be configured from supplied path and defaulted in case the supplied path does not resolve to existing node

Declaration
public ConfigAttribute(string path, object defaultValue)
Parameters
Type Name Description
System.String path
System.Object defaultValue

Properties

Default

Default value used when configuration does not specify any other value

Declaration
public object Default { get; set; }
Property Value
Type Description
System.Object

Path

String path of configuration source i.e. 'log/machine-name'. Path is relative to item root

Declaration
public string Path { get; set; }
Property Value
Type Description
System.String

Verbatim

Takes verbatim value if true

Declaration
public bool Verbatim { get; set; }
Property Value
Type Description
System.Boolean

Methods

Apply(Object, IConfigSectionNode)

Applies config values to fields/properties as specified by config attributes

Declaration
public static object Apply(object entity, IConfigSectionNode node)
Parameters
Type Name Description
System.Object entity
IConfigSectionNode node
Returns
Type Description
System.Object

Apply<T>(T, IConfigSectionNode)

Applies config values to fields/properties as specified by config attributes

Declaration
public static T Apply<T>(T entity, IConfigSectionNode node)
Parameters
Type Name Description
T entity
IConfigSectionNode node
Returns
Type Description
T
Type Parameters
Name Description
T

GetConfigPathsForMember(MemberInfo)

Generates 2 attribute paths for named member. This first path is just the member name converted to lower case. The seconfd path is "OR"ed with the first one and is taken from member name where all case transitions are prefixed with "-". For private fields 'm_' and 's_' prefixes are removed

Declaration
public static string GetConfigPathsForMember(MemberInfo member)
Parameters
Type Name Description
System.Reflection.MemberInfo member
Returns
Type Description
System.String

Extension Methods