BaseIssueProvider Class

Summary

Base class for all issue provider implementations.
graph BT Type-->Base0["BaseIssueComponent<IReadIssuesSettings>"] Base0-->Base1["Object"] Type-.->Interface0["IIssueProvider"] click Interface0 "/api/Cake.Issues/IIssueProvider" Type-.->Interface1["IBaseIssueComponent<IReadIssuesSettings>"] Type["BaseIssueProvider"] class Type type-node Derived0["BaseConfigurableIssueProvider<T>"]-->Type click Derived0 "/api/Cake.Issues/BaseConfigurableIssueProvider_1"

Syntax

public abstract class BaseIssueProvider : BaseIssueComponent<IReadIssuesSettings>, IIssueProvider, 
    IBaseIssueComponent<IReadIssuesSettings>

Constructors

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

Properties

Name Value Summary
ProviderName string
Gets the human friendly name of the issue provider.
ProviderType string
Gets the type of the issue provider.

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.

Extension Methods

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