IssueBuilder Class

Summary

Class to create instances of IIssue with a fluent API.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["IssueBuilder"] class Type type-node

Syntax

public class IssueBuilder

Methods

Name Value Summary
Create() IIssue
Creates a new IIssue.
InFile(string) IssueBuilder
Sets the path to the file affected by the issue.
InFile(string, Nullable<int>) IssueBuilder
Sets the path to the file affected by the issue and the line in the file where the issues has occurred.
InProject(string, string) IssueBuilder
Sets the project to which the file affected by the issue belongs.
InProjectFile(string) IssueBuilder
Sets the path of the project to which the file affected by the issue belongs.
InProjectOfName(string) IssueBuilder
Sets the name of the project to which the file affected by the issue belongs.
NewIssue(string, string, string) IssueBuilder
Initiates the creation of a new IIssue.
static
NewIssue<T>(string, T) IssueBuilder
Initiates the creation of a new IIssue.
static
OfRule(string) IssueBuilder
Sets the rule of the issue.
OfRule(string, Uri) IssueBuilder
Sets the rule of the issue.
WithMessageInHtmlFormat(string) IssueBuilder
Sets the message in HTML format.
WithMessageInMarkdownFormat(string) IssueBuilder
Sets the message in Markdown format.
WithPriority(IssuePriority) IssueBuilder
Sets the priority of the issue.
WithPriority(Nullable<int>, string) IssueBuilder
Sets the priority of the issue.

Extension Methods

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