Summary
Base class for setup logic.
- Namespace
- Cake
.Frosting - Interfaces
- Base Types
-
- object
- Derived Types
graph BT
Type-->Base0["object"]
Type-.->Interface0["IFrostingSetup"]
click Interface0 "/api/Cake.Frosting/IFrostingSetup"
Type["FrostingSetup<TContext>"]
class Type type-node
Derived0["FrostingSetup"]-->Type
click Derived0 "/api/Cake.Frosting/FrostingSetup"
Syntax
public abstract class FrostingSetup<TContext> : IFrostingSetup where TContext : ICakeContextType Parameters
| Name | Description |
|---|---|
| TContext | The build context type. |
Methods
| Name | Value | Summary |
|---|---|---|
| Setup |
void |
This method is executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
|
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
|