NuGetTool<TSettings> Class

Summary

Base class for all NuGet related tools.
Namespace
Cake.Common.Tools.NuGet
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["NuGetTool<TSettings>"] class Type type-node Derived0["NuGetInstaller"]-->Type click Derived0 "/api/Cake.Common.Tools.NuGet.Install/NuGetInstaller" Derived1["NuGetDeleter"]-->Type click Derived1 "/api/Cake.Common.Tools.NuGet.Delete/NuGetDeleter" Derived2["NuGetIniter"]-->Type click Derived2 "/api/Cake.Common.Tools.NuGet.Init/NuGetIniter" Derived3["NuGetSetApiKey"]-->Type click Derived3 "/api/Cake.Common.Tools.NuGet.SetApiKey/NuGetSetApiKey" Derived4["NuGetPusher"]-->Type click Derived4 "/api/Cake.Common.Tools.NuGet.Push/NuGetPusher" Derived5["NuGetPacker"]-->Type click Derived5 "/api/Cake.Common.Tools.NuGet.Pack/NuGetPacker" Derived6["NuGetSources"]-->Type click Derived6 "/api/Cake.Common.Tools.NuGet.Sources/NuGetSources" Derived7["NuGetRestorer"]-->Type click Derived7 "/api/Cake.Common.Tools.NuGet.Restore/NuGetRestorer" Derived8["NuGetSetProxy"]-->Type click Derived8 "/api/Cake.Common.Tools.NuGet.SetProxy/NuGetSetProxy" Derived9["NuGetAdder"]-->Type click Derived9 "/api/Cake.Common.Tools.NuGet.Add/NuGetAdder" Derived10["NuGetList"]-->Type click Derived10 "/api/Cake.Common.Tools.NuGet.List/NuGetList" Derived11["NuGetUpdater"]-->Type click Derived11 "/api/Cake.Common.Tools.NuGet.Update/NuGetUpdater"

Syntax

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

Type Parameters

Name Description
TSettings The settings type.

Constructors

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

Methods

Name Value Summary
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.

Extension Methods

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