BaseConfigurableIssueProvider<T> Class

Summary

Base class for all issue provider implementations with issue provider specific settings.
graph BT Type-->Base0["BaseIssueProvider"] click Base0 "/api/Cake.Issues/BaseIssueProvider" Base0-->Base1["BaseIssueComponent<IReadIssuesSettings>"] Base1-->Base2["Object"] Type-.->Interface0["IIssueProvider"] click Interface0 "/api/Cake.Issues/IIssueProvider" Type-.->Interface1["IBaseIssueComponent<IReadIssuesSettings>"] Type["BaseConfigurableIssueProvider<T>"] class Type type-node Derived0["BaseMultiFormatIssueProvider<TSettings, TIssueProvider>"]-->Type click Derived0 "/api/Cake.Issues/BaseMultiFormatIssueProvider_2"

Syntax

public abstract class BaseConfigurableIssueProvider<T> : BaseIssueProvider, IIssueProvider, 
    IBaseIssueComponent<IReadIssuesSettings>
    where T : IssueProviderSettings

Type Parameters

Name Description
T Type of the issue provider settings.

Constructors

Name Summary
BaseConfigurableIssueProvider(ICakeLog, T) Initializes a new instance of the BaseConfigurableIssueProvider<T> class.

Properties

Name Value Summary
IssueProviderSettings T
Gets the settings for the issue provider.
ProviderName string
Gets the human friendly name of the issue provider.
Inherited from BaseIssueProvider
ProviderType string
Gets the type of the issue provider.
Inherited from BaseIssueProvider

Methods

Name Value Summary
InternalReadIssues() IEnumerable<IIssue>
Gets all issues. Compared to ReadIssues() it is safe to access Settings from this method.
Inherited from BaseIssueProvider
ReadIssues() IEnumerable<IIssue>
Gets all issues.
Inherited from BaseIssueProvider

Extension Methods

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