GemTool<TSettings> Class

Summary

Base class for all gem related tools.
Assembly
Cake.Gem.dll
Namespace
Cake.Gem
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["GemTool<TSettings>"] class Type type-node Derived0["GemBuildRunner"]-->Type click Derived0 "/api/Cake.Gem.Build/GemBuildRunner" Derived1["GemPushRunner"]-->Type click Derived1 "/api/Cake.Gem.Push/GemPushRunner"

Syntax

public abstract class GemTool<TSettings> : Tool<TSettings> where TSettings : GemSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

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

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
RunGem<TBuilder>(TSettings, TBuilder) void
Runs the Gem tool with the specified settings.

Extension Methods

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