ILogFileFormat<TIssueProvider, TSettings> Interface

Summary

Definition of a log file format for IIssueProvider which support different log file formats.
graph BT Type["ILogFileFormat<TIssueProvider, TSettings>"] class Type type-node Implementing0["BaseLogFileFormat<TIssueProvider, TSettings>"]-.->Type click Implementing0 "/api/Cake.Issues/BaseLogFileFormat_2" Implementing1["BaseMsBuildLogFileFormat"]-.->Type click Implementing1 "/api/Cake.Issues.MsBuild/BaseMsBuildLogFileFormat" Implementing2["BaseEsLintLogFileFormat"]-.->Type click Implementing2 "/api/Cake.Issues.EsLint/BaseEsLintLogFileFormat" Implementing3["BaseMarkdownlintLogFileFormat"]-.->Type click Implementing3 "/api/Cake.Issues.Markdownlint/BaseMarkdownlintLogFileFormat" Implementing4["FakeLogFileFormat"]-.->Type click Implementing4 "/api/Cake.Issues.Testing/FakeLogFileFormat"

Syntax

public interface 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.

Methods

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

Extension Methods

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