BaseLogFileFormat<TIssueProvider, TSettings> Class

Summary

Base class for all log file format implementations.
graph BT Type-->Base0["Object"] Type-.->Interface0["ILogFileFormat<TIssueProvider, TSettings>"] Type["BaseLogFileFormat<TIssueProvider, TSettings>"] class Type type-node Derived0["BaseMsBuildLogFileFormat"]-->Type click Derived0 "/api/Cake.Issues.MsBuild/BaseMsBuildLogFileFormat" Derived1["BaseEsLintLogFileFormat"]-->Type click Derived1 "/api/Cake.Issues.EsLint/BaseEsLintLogFileFormat" Derived2["BaseMarkdownlintLogFileFormat"]-->Type click Derived2 "/api/Cake.Issues.Markdownlint/BaseMarkdownlintLogFileFormat" Derived3["FakeLogFileFormat"]-->Type click Derived3 "/api/Cake.Issues.Testing/FakeLogFileFormat"

Syntax

public abstract class BaseLogFileFormat<TIssueProvider, TSettings> : 
    ILogFileFormat<TIssueProvider, TSettings>
    
    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
BaseLogFileFormat(ICakeLog) Initializes a new instance of the BaseLogFileFormat<TIssueProvider, TSettings> class.

Properties

Name Value Summary
Log ICakeLog
Gets the Cake log instance.

Methods

Name Value Summary
ReadIssues(TIssueProvider, RepositorySettings, TSettings) IEnumerable<IIssue>
Gets all issues.

Extension Methods

Name Value Summary
Dump<BaseLogFileFormat<TIssueProvider, TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BaseLogFileFormat<TIssueProvider, TSettings>>(BaseLogFileFormat<TIssueProvider, TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BaseLogFileFormat<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