IssueReportFormat Class

Summary

Base class for all report format implementations.
graph BT Type-->Base0["BaseIssueComponent<ICreateIssueReportSettings>"] Base0-->Base1["Object"] Type-.->Interface0["IIssueReportFormat"] click Interface0 "/api/Cake.Issues.Reporting/IIssueReportFormat" Type-.->Interface1["IBaseIssueComponent<ICreateIssueReportSettings>"] Type["IssueReportFormat"] class Type type-node

Syntax

public abstract class IssueReportFormat : BaseIssueComponent<ICreateIssueReportSettings>, 
    IIssueReportFormat, IBaseIssueComponent<ICreateIssueReportSettings>

Constructors

Name Summary
IssueReportFormat(ICakeLog) Initializes a new instance of the IssueReportFormat class.

Methods

Name Value Summary
CreateReport(IEnumerable<IIssue>) FilePath
Creates a report from a list of issues.
InternalCreateReport(IEnumerable<IIssue>) FilePath
Creates a report from a list of issues. Compared to Cake.Issues.Reporting.IssueReportFormat.CreateReport(System.Collections.Generic.IEnumerable{Cake.Issues.IIssue}) it is safe to access Settings from this method.

Extension Methods

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