This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Gem.
Summary
Base class for all gem related tools.
- Assembly
- Cake
.Gem .dll - Namespace
- Cake
.Gem - Base Types
-
- Tool
<TSettings>
- Tool
- 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 : GemSettingsType Parameters
| Name | Description |
|---|---|
| TSettings | The settings type. |
Constructors
| Name | Summary |
|---|---|
| GemTool |
Initializes a new instance of the GemTool<TSettings> class.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Get |
IEnumerable |
Gets the possible names of the tool executable.
|
| GetToolName |
string |
Gets the name of the tool.
|
| RunGem |
void |
Runs the Gem tool with the specified settings.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|