Summary
Allows configuration to be performed for a registered
CakeTask.
- Namespace
- Cake
.Core - Base Types
-
- object
graph BT
Type-->Base0["object"]
Type["CakeTaskBuilder<TData>"]
class Type type-node
Syntax
public sealed class CakeTaskBuilder<TData> where TData : classType Parameters
| Name | Description |
|---|---|
| TData | The type of the data context. |
Constructors
| Name | Summary |
|---|---|
| CakeTaskBuilder |
Initializes a new instance of the CakeTaskBuilder<TData> class.
|
| CakeTaskBuilder |
Initializes a new instance of the CakeTaskBuilder<TData> class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| Builder | CakeTaskBuilder |
Gets the cake task builder.
|
| Task | ICakeTaskInfo |
Gets a read-only representation of the task being configured.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| ContinueOnError |
CakeTaskBuilder |
Adds an indication to the task that a thrown exception will not halt the script execution.
|
| DeferOnError |
CakeTaskBuilder |
Defers all exceptions until after all actions for this task have completed.
|
| Description |
CakeTaskBuilder |
Adds a description to the task.
|
| Does |
CakeTaskBuilder |
Adds an action to be executed when the task is invoked.
|
| Does |
CakeTaskBuilder |
Adds an action to be executed when the task is invoked.
|
| DoesForEach |
CakeTaskBuilder |
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
|
| DoesForEach |
CakeTaskBuilder |
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| Finally |
CakeTaskBuilder |
Adds a finally handler to be executed after the task have finished executing.
|
| Finally |
CakeTaskBuilder |
Adds a finally handler to be executed after the task have finished executing.
|
| IsDependeeOf |
CakeTaskBuilder |
Makes the task a dependee of another task.
|
| IsDependeeOf |
CakeTaskBuilder |
Makes the task a dependee of another task.
|
| IsDependentOn |
CakeTaskBuilder |
Creates a dependency between two tasks.
|
| IsDependentOn |
CakeTaskBuilder |
Creates a dependency between two tasks.
|
| IsDependentOn |
CakeTaskBuilder |
Creates a dependency between two tasks.
|
| 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
|
| OnError |
CakeTaskBuilder |
Adds an error handler to be executed if an exception occurs in the task.
|
| OnError |
CakeTaskBuilder |
Adds an error handler to be executed if an exception occurs in the task.
|
| ReportError |
CakeTaskBuilder |
Adds an error reporter for the task to be executed when an exception is thrown from the task.
This action is invoked before the error handler, but gives no opportunity to recover from the error.
|
| 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
|
| WithCriteria |
CakeTaskBuilder |
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
|
| WithCriteria |
CakeTaskBuilder |
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
|