This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Issues.

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["EsLintIssuesProvider"]-->Type click Derived2 "/api/Cake.Issues.EsLint/EsLintIssuesProvider" Derived3["TapIssuesProvider"]-->Type click Derived3 "/api/Cake.Issues.Tap/TapIssuesProvider"

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)	Base class for issue providers supporting multiple log formats.

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
Dump<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>(BaseMultiFormatIssueProvider<TSettings, TIssueProvider>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<BaseMultiFormatIssueProvider<TSettings, TIssueProvider>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin