Skip to content

Class PatternDescriptor

Namespace: Cephalon.Abstractions.Patterns
Assembly: Cephalon.Abstractions.dll

Describes one pattern that can shape a Cephalon app.

public sealed class PatternDescriptor

objectPatternDescriptor

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

PatternDescriptor(string, string, string, PatternKind, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)

Section titled “ PatternDescriptor(string, string, string, PatternKind, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”

Creates a pattern descriptor.

public PatternDescriptor(string id, string displayName, string description, PatternKind kind, IReadOnlyList<string>? aliases = null, IReadOnlyList<string>? tags = null, IReadOnlyList<string>? requires = null, IReadOnlyList<string>? conflictsWith = null, IReadOnlyDictionary<string, string>? metadata = null)

id string

The stable pattern identifier.

displayName string

The human-readable pattern name.

description string

The pattern description.

kind PatternKind

The category of the pattern.

aliases IReadOnlyList<string>?

Optional aliases that can resolve to the same pattern.

tags IReadOnlyList<string>?

The tags associated with the pattern.

requires IReadOnlyList<string>?

The pattern identifiers required by this pattern.

conflictsWith IReadOnlyList<string>?

The pattern identifiers that conflict with this pattern.

metadata IReadOnlyDictionary<string, string>?

Optional pattern metadata.

Gets optional aliases that can resolve to the same pattern.

public IReadOnlyList<string> Aliases { get; }

IReadOnlyList<string>

Gets the pattern identifiers that conflict with this pattern.

public IReadOnlyList<string> ConflictsWith { get; }

IReadOnlyList<string>

Gets the pattern description.

public string Description { get; }

string

Gets the human-readable pattern name.

public string DisplayName { get; }

string

Gets the stable pattern identifier.

public string Id { get; }

string

Gets the category of the pattern.

public PatternKind Kind { get; }

PatternKind

Gets optional pattern metadata.

public IReadOnlyDictionary<string, string> Metadata { get; }

IReadOnlyDictionary<string, string>

Gets the pattern identifiers required by this pattern.

public IReadOnlyList<string> Requires { get; }

IReadOnlyList<string>

Gets the tags associated with the pattern.

public IReadOnlyList<string> Tags { get; }

IReadOnlyList<string>