BaseMultiFormatIssueProvider<TSettings, TIssueProvider> Class

Summary

Base class for issue providers supporting multiple log formats.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["BaseConfigurableIssueProvider<TSettings>"] Base0-->Base1["BaseIssueProvider"] click Base1 "/api/Cake.Issues/BaseIssueProvider" Base1-->Base2["BaseIssueComponent<IReadIssuesSettings>"] Base2-->Base3["Object"] Type-.->Interface0["IIssueProvider"] click Interface0 "/api/Cake.Issues/IIssueProvider" Type-.->Interface1["IBaseIssueComponent<IReadIssuesSettings>"] Type["BaseMultiFormatIssueProvider<TSettings, TIssueProvider>"] class Type type-node Derived0["MsBuildIssuesProvider"]-->Type click Derived0 "/api/Cake.Issues.MsBuild/MsBuildIssuesProvider" Derived1["MarkdownlintIssuesProvider"]-->Type click Derived1 "/api/Cake.Issues.Markdownlint/MarkdownlintIssuesProvider" Derived2["FakeMultiFormatIssueProvider"]-->Type click Derived2 "/api/Cake.Issues.Testing/FakeMultiFormatIssueProvider" Derived3["EsLintIssuesProvider"]-->Type click Derived3 "/api/Cake.Issues.EsLint/EsLintIssuesProvider"

Syntax

public abstract class BaseMultiFormatIssueProvider<TSettings, TIssueProvider> : 
    BaseConfigurableIssueProvider<TSettings>, IIssueProvider, 
    IBaseIssueComponent<IReadIssuesSettings>
    
    where TSettings : BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings> where TIssueProvider : BaseMultiFormatIssueProvider<TSettings, TIssueProvider>

Type Parameters

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

Constructors

Name Summary
BaseMultiFormatIssueProvider(ICakeLog, TSettings) Initializes a new instance of the BaseMultiFormatIssueProvider<TSettings, TIssueProvider> class.

Properties

Name Value Summary
ProviderName string
Gets the human friendly name of the issue provider.
Inherited from BaseIssueProvider
ProviderType string
Gets the type of the issue provider.
Inherited from BaseIssueProvider

Methods

Name Value Summary
InternalReadIssues() IEnumerable<IIssue>
Gets all issues. Compared to ReadIssues() it is safe to access Settings from this method.
ReadIssues() IEnumerable<IIssue>
Gets all issues.
Inherited from BaseIssueProvider

Extension Methods

Name Value Summary
NotNull<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>(string) void
Throws an exception if the specified parameter's value is null.
GitHub