ChocolateyTool<TSettings> Class

Summary

Base class for all Chocolatey related tools.
Namespace
Cake.Common.Tools.Chocolatey
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["ChocolateyTool<TSettings>"] class Type type-node Derived0["ChocolateyScaffolder"]-->Type click Derived0 "/api/Cake.Common.Tools.Chocolatey.New/ChocolateyScaffolder" Derived1["ChocolateyPinner"]-->Type click Derived1 "/api/Cake.Common.Tools.Chocolatey.Pin/ChocolateyPinner" Derived2["ChocolateyUninstaller"]-->Type click Derived2 "/api/Cake.Common.Tools.Chocolatey.Uninstall/ChocolateyUninstaller" Derived3["ChocolateyInstaller"]-->Type click Derived3 "/api/Cake.Common.Tools.Chocolatey.Install/ChocolateyInstaller" Derived4["ChocolateySources"]-->Type click Derived4 "/api/Cake.Common.Tools.Chocolatey.Sources/ChocolateySources" Derived5["ChocolateyPusher"]-->Type click Derived5 "/api/Cake.Common.Tools.Chocolatey.Push/ChocolateyPusher" Derived6["ChocolateyApiKeySetter"]-->Type click Derived6 "/api/Cake.Common.Tools.Chocolatey.ApiKey/ChocolateyApiKeySetter" Derived7["ChocolateyPacker"]-->Type click Derived7 "/api/Cake.Common.Tools.Chocolatey.Pack/ChocolateyPacker" Derived8["ChocolateyDownloader"]-->Type click Derived8 "/api/Cake.Common.Tools.Chocolatey.Download/ChocolateyDownloader" Derived9["ChocolateyFeatureToggler"]-->Type click Derived9 "/api/Cake.Common.Tools.Chocolatey.Features/ChocolateyFeatureToggler" Derived10["ChocolateyUpgrader"]-->Type click Derived10 "/api/Cake.Common.Tools.Chocolatey.Upgrade/ChocolateyUpgrader" Derived11["ChocolateyConfigSetter"]-->Type click Derived11 "/api/Cake.Common.Tools.Chocolatey.Config/ChocolateyConfigSetter" Derived12["ChocolateyExporter"]-->Type click Derived12 "/api/Cake.Common.Tools.Chocolatey.Export/ChocolateyExporter"

Syntax

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

Type Parameters

Name Description
TSettings The settings type.

Constructors

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

Methods

Name Value Summary
AddGlobalArguments(ChocolateySettings, ProcessArgumentBuilder) ProcessArgumentBuilder
Adds common arguments to the process builder.
AddSharedArguments(ChocolateySharedSettings, ProcessArgumentBuilder) ProcessArgumentBuilder
Adds shared arguents 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.

Extension Methods

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