VSWhereTool<TSettings> Class

Summary

Base class for all VSWhere related tools. Used to locate Visual Studio.
Namespace
Cake.Common.Tools.VSWhere
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["VSWhereTool<TSettings>"] class Type type-node Derived0["VSWhereAll"]-->Type click Derived0 "/api/Cake.Common.Tools.VSWhere.All/VSWhereAll" Derived1["VSWhereProduct"]-->Type click Derived1 "/api/Cake.Common.Tools.VSWhere.Product/VSWhereProduct" Derived2["VSWhereLegacy"]-->Type click Derived2 "/api/Cake.Common.Tools.VSWhere.Legacy/VSWhereLegacy" Derived3["VSWhereLatest"]-->Type click Derived3 "/api/Cake.Common.Tools.VSWhere.Latest/VSWhereLatest"

Syntax

public abstract class VSWhereTool<TSettings> : Tool<TSettings> where TSettings : ToolSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

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

Methods

Name Value Summary
AddCommonArguments(VSWhereSettings, ProcessArgumentBuilder) ProcessArgumentBuilder
Adds common arguments to the process builder.
GetAlternativeToolPaths(TSettings) IEnumerable<FilePath>
Gets alternative file paths which the tool may exist in.
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
RunVSWhere(TSettings, ProcessArgumentBuilder) DirectoryPathCollection
Runs VSWhere with supplied arguments and parses installation paths.

Extension Methods

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