BaseIssueComponent<T> Class

Summary

Base class for all Cake.Issues component.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Interfaces
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type-.->Interface0["IBaseIssueComponent<T>"] Type["BaseIssueComponent<T>"] class Type type-node Derived0["BaseIssueProvider"]-->Type click Derived0 "/api/Cake.Issues/BaseIssueProvider" Derived1["BasePullRequestSystem"]-->Type click Derived1 "/api/Cake.Issues.PullRequests/BasePullRequestSystem" Derived2["IssueReportFormat"]-->Type click Derived2 "/api/Cake.Issues.Reporting/IssueReportFormat"

Syntax

public abstract class BaseIssueComponent<T> : IBaseIssueComponent<T> 
    where T : class, IRepositorySettings

Type Parameters

Name Description
T Type of settings.

Constructors

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

Properties

Name Value Summary
Log ICakeLog
Gets the Cake log context.
Settings T
Gets the settings. Is set after Initialize(T) was called from the core add-in.

Methods

Name Value Summary
AssertInitialized() void
Asserts that Initialize(T) was called.
Initialize(T) bool
Initializes the component.

Extension Methods

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