YamlTypeClassifierContext Class

Namespace: Meziantou.Framework.Yaml.Serialization
Assembly: Meziantou.Framework.Yaml.dll
Package: Meziantou.Framework.Yaml 2.0.11
Source: YamlTypeClassifierContext.cs
Available in package assets: net10.0net11.0

Describes the type a YamlTypeClassifierFactory is asked to classify.

public sealed class YamlTypeClassifierContext

Properties

Name	Description
DeclaringType	Gets the type being classified.
DerivedTypes	Gets the types derived from `YamlTypeClassifierContext.DeclaringType`, when it is a polymorphic type.
Kind	Gets the kind of the type being classified.
TypeDiscriminatorPropertyName	Gets the mapping key carrying the type discriminator, when `YamlTypeClassifierContext.DeclaringType` uses one.
UnionCases	Gets the cases declared by `YamlTypeClassifierContext.DeclaringType`, when it is a union type.

DeclaringType

YamlTypeClassifierContext.cs

Gets the type being classified.

public Type DeclaringType { get; }

Property value

Type

DerivedTypes

YamlTypeClassifierContext.cs

Gets the types derived from YamlTypeClassifierContext.DeclaringType, when it is a polymorphic type.

public ReadOnlyCollection<YamlDerivedType> DerivedTypes { get; }

Property value

ReadOnlyCollection<YamlDerivedType>

Kind

YamlTypeClassifierContext.cs

Gets the kind of the type being classified.

public YamlTypeClassifierKind Kind { get; }

Property value

YamlTypeClassifierKind

TypeDiscriminatorPropertyName

YamlTypeClassifierContext.cs

Gets the mapping key carrying the type discriminator, when YamlTypeClassifierContext.DeclaringType uses one.

public string? TypeDiscriminatorPropertyName { get; }

Property value

string?

UnionCases

YamlTypeClassifierContext.cs

Gets the cases declared by YamlTypeClassifierContext.DeclaringType, when it is a union type.

public ReadOnlyCollection<YamlUnionCaseInfo> UnionCases { get; }

Property value

ReadOnlyCollection<YamlUnionCaseInfo>

Methods

Name	Description
CreateForPolymorphicType(Type, IReadOnlyList<YamlDerivedType>, string?)	Creates a context describing a polymorphic type.
CreateForUnion(Type, IReadOnlyList<YamlUnionCaseInfo>)	Creates a context describing a C# union type.

CreateForPolymorphicType(Type, IReadOnlyList<YamlDerivedType>, string?)

YamlTypeClassifierContext.cs

Creates a context describing a polymorphic type.

public static YamlTypeClassifierContext CreateForPolymorphicType(Type declaringType, IReadOnlyList<YamlDerivedType> derivedTypes, string? typeDiscriminatorPropertyName)

Parameters

declaringType Type: The base type.
derivedTypes IReadOnlyList<YamlDerivedType>: The types derived from declaringType.
typeDiscriminatorPropertyName string?: The mapping key carrying the type discriminator, when the type uses one.

Returns

YamlTypeClassifierContext The context to create a classifier from.

Exceptions

ArgumentNullException: declaringType or derivedTypes is null.
ArgumentException: A derived type entry is null.

CreateForUnion(Type, IReadOnlyList<YamlUnionCaseInfo>)

YamlTypeClassifierContext.cs

Creates a context describing a C# union type.

public static YamlTypeClassifierContext CreateForUnion(Type declaringType, IReadOnlyList<YamlUnionCaseInfo> unionCases)

Parameters

declaringType Type: The union type.
unionCases IReadOnlyList<YamlUnionCaseInfo>: The cases declared by declaringType.

Returns

YamlTypeClassifierContext The context to create a classifier from.

Exceptions

ArgumentNullException: declaringType or unionCases is null.
ArgumentException: A case entry is null.