BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings> Class

Summary

Base settings for BaseMultiFormatIssueProvider<TSettings, TIssueProvider>.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Base Types
Derived Types
graph BT Type-->Base0["IssueProviderSettings"] click Base0 "/api/Cake.Issues/IssueProviderSettings" Base0-->Base1["Object"] Type["BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>"] class Type type-node Derived0["MsBuildIssuesSettings"]-->Type click Derived0 "/api/Cake.Issues.MsBuild/MsBuildIssuesSettings" Derived1["EsLintIssuesSettings"]-->Type click Derived1 "/api/Cake.Issues.EsLint/EsLintIssuesSettings" Derived2["MarkdownlintIssuesSettings"]-->Type click Derived2 "/api/Cake.Issues.Markdownlint/MarkdownlintIssuesSettings"

Syntax

public abstract class BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings> : 
    IssueProviderSettings
    
    where TIssueProvider : BaseMultiFormatIssueProvider<TSettings, TIssueProvider> where TSettings : BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>

Type Parameters

Name Description
TIssueProvider Type of the issue provider.
TSettings Type of the settings.

Constructors

Name Summary
BaseMultiFormatIssueProviderSettings(byte[], ILogFileFormat<TIssueProvider, TSettings>) Initializes a new instance of the BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings> class for a log file content in memory.
BaseMultiFormatIssueProviderSettings(FilePath, ILogFileFormat<TIssueProvider, TSettings>) Initializes a new instance of the BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings> class for reading a log file on disk.

Properties

Name Value Summary
Format ILogFileFormat<TIssueProvider, TSettings>
Gets the format of the log file.
LogFileContent byte[]
Gets the content of the log file.
Inherited from IssueProviderSettings

Extension Methods

Name Value Summary
Dump<BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>>(BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin