Class ConfigurationTraversalContext

Inheritance

System.Object

ConfigurationTraversalContext

Implements

IConfigurationTraversalContext

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Snowflake.Configuration.Serialization

Assembly: Snowflake.Framework.dll

Syntax

public sealed class ConfigurationTraversalContext : IConfigurationTraversalContext

Constructors

ConfigurationTraversalContext(IDictionary<String, IReadOnlyDirectory>)

Creates a traversal context with the given path resolutions.

Declaration

public ConfigurationTraversalContext(IDictionary<string, IReadOnlyDirectory> pathResolutionContext)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, IReadOnlyDirectory>	pathResolutionContext	The path resolutions supplied as a dictionary.

ConfigurationTraversalContext((String directoryNamespace, IReadOnlyDirectory directory)[])

Creates a traversal context with the given path resolutions.

Use the syntax

new ConfigurationTraversalContext(("drive", myDirectory), ("drive2", my2ndDirectory));

Declaration

public ConfigurationTraversalContext(params (string directoryNamespace, IReadOnlyDirectory directory)[] pathResolutionContext)

Parameters

Type	Name	Description
System.ValueTuple<System.String, IReadOnlyDirectory>[]	pathResolutionContext	A list of tuples of strings and IDirectory that specify each namespaced path.

Fields

NullTarget

Special string for the null target that is never serialized.

Declaration

public static string NullTarget

Field Value

Type	Description
System.String

Methods

TraverseCollection(IConfigurationCollection)

Declaration

public IReadOnlyDictionary<string, IAbstractConfigurationNode<IReadOnlyList<IAbstractConfigurationNode>>> TraverseCollection(IConfigurationCollection collection)

Parameters

Type	Name	Description
IConfigurationCollection	collection

Returns

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, IAbstractConfigurationNode<System.Collections.Generic.IReadOnlyList<IAbstractConfigurationNode>>>

TraverseCollection(IConfigurationCollection, IEnumerable<(String targetName, IAbstractConfigurationNode node)>)

Declaration

public IReadOnlyDictionary<string, IAbstractConfigurationNode<IReadOnlyList<IAbstractConfigurationNode>>> TraverseCollection(IConfigurationCollection collection, IEnumerable<(string targetName, IAbstractConfigurationNode node)> extraNodes)

Parameters

Type	Name	Description
IConfigurationCollection	collection
System.Collections.Generic.IEnumerable<System.ValueTuple<System.String, IAbstractConfigurationNode>>	extraNodes

Returns

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, IAbstractConfigurationNode<System.Collections.Generic.IReadOnlyList<IAbstractConfigurationNode>>>

TraverseInputTemplate(IInputTemplate, IDeviceInputMapping, Int32, String)

Declaration

public IAbstractConfigurationNode<IReadOnlyList<IAbstractConfigurationNode>> TraverseInputTemplate(IInputTemplate template, IDeviceInputMapping mapping, int index, string indexer = "{N}")

Parameters

Type	Name	Description
IInputTemplate	template
IDeviceInputMapping	mapping
System.Int32	index
System.String	indexer

Returns

Type	Description
IAbstractConfigurationNode<System.Collections.Generic.IReadOnlyList<IAbstractConfigurationNode>>

Implements

IConfigurationTraversalContext