DotCoverTool<TSettings> Class

Summary

Base class for all DotCover related tools.
Namespace
Cake.Common.Tools.DotCover
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["DotCoverTool<TSettings>"] class Type type-node Derived0["DotCoverMerger"]-->Type click Derived0 "/api/Cake.Common.Tools.DotCover.Merge/DotCoverMerger" Derived1["DotCoverCoverageTool<TSettings>"]-->Type click Derived1 "/api/Cake.Common.Tools.DotCover/DotCoverCoverageTool_1" Derived2["DotCoverReporter"]-->Type click Derived2 "/api/Cake.Common.Tools.DotCover.Report/DotCoverReporter"

Syntax

public abstract class DotCoverTool<TSettings> : Tool<TSettings> where TSettings : DotCoverSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Name Summary
DotCoverTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the DotCoverTool<TSettings> class.

Methods

Name Value Summary
GetArguments(DotCoverSettings) ProcessArgumentBuilder
Get arguments from global settings.
GetConfigurationFileArgument(DotCoverSettings) ProcessArgumentBuilder
Get configuration full path from coverage settings.
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.

Extension Methods

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