BaseRuleUrlResolver<T> Class

Summary

Base class for retrieving a URL linking to a site containing help for a rule.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["BaseRuleUrlResolver<T>"] class Type type-node

Syntax

public abstract class BaseRuleUrlResolver<T> where T : BaseRuleDescription, new()

Type Parameters

Name Description
T Type of the rule description.

Constructors

Name Summary
BaseRuleUrlResolver()

Methods

Name Value Summary
AddUrlResolver(Func<T, Uri>, int) void
Registers a new resolver with a specific priority.
AddUrlResolver(Func<T, Uri>) void
Registers a new resolver with default priority of 0.
ResolveRuleUrl(string) Uri
Returns a URL linking to a site describing a specific rule.
TryGetRuleDescription(string, T) bool
Parses a rule into a BaseRuleDescription.

Extension Methods

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