CakeTaskBuilder Class

Summary

Allows configuration to be performed for a registered CakeTask.
Namespace
Cake.Core
Base Types
  • object
graph BT Type-->Base0["object"] Type["CakeTaskBuilder"] class Type type-node

Syntax

public sealed class CakeTaskBuilder

Properties

Name Value Summary
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(string) CakeTaskBuilder
Adds a description to the task.
Does(Action) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does(Action<ICakeContext>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does(Func<ICakeContext, Task>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does(Func<Task>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does<TData>(Action<ICakeContext, TData>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does<TData>(Action<TData>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does<TData>(Func<ICakeContext, TData, Task>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
Does<TData>(Func<TData, Task>) CakeTaskBuilder
Adds an action to be executed when the task is invoked.
DoesForEach<TData, TItem>(Func<ICakeContext, IEnumerable<TItem>>, Action<TData, TItem>) 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<TData, TItem>(Func<IEnumerable<TItem>>, Action<TData, TItem, ICakeContext>) 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<TData, TItem>(Func<IEnumerable<TItem>>, Action<TData, TItem>) 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<TData, TItem>(Func<TData, ICakeContext, IEnumerable<TItem>>, Action<TData, TItem, ICakeContext>) 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<TData, TItem>(Func<TData, IEnumerable<TItem>>, Action<TData, TItem, ICakeContext>) 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<TData, TItem>(IEnumerable<TItem>, Action<TData, TItem, ICakeContext>) CakeTaskBuilder
Adds an action to be executed foreach item in the list.
DoesForEach<TData, TItem>(IEnumerable<TItem>, Action<TData, TItem>) CakeTaskBuilder
Adds an action to be executed foreach item in the list.
DoesForEach<TItem>(Func<ICakeContext, IEnumerable<TItem>>, Action<TItem, ICakeContext>) 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<TItem>(Func<ICakeContext, IEnumerable<TItem>>, Action<TItem>) 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<TItem>(Func<IEnumerable<TItem>>, Action<TItem, ICakeContext>) 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<TItem>(Func<IEnumerable<TItem>>, Action<TItem>) 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<TItem>(IEnumerable<TItem>, Action<TItem, ICakeContext>) CakeTaskBuilder
Adds an action to be executed foreach item in the list.
DoesForEach<TItem>(IEnumerable<TItem>, Action<TItem>) CakeTaskBuilder
Adds an action to be executed foreach item in the list.
Dump<CakeTaskBuilder>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Finally(Action) CakeTaskBuilder
Adds a finally handler to be executed after the task have finished executing.
IsDependeeOf(string) CakeTaskBuilder
Makes the task a dependency of another task.
IsDependentOn(CakeTaskBuilder) CakeTaskBuilder
Creates a dependency between two tasks.
IsDependentOn(string) CakeTaskBuilder
Creates a dependency between two tasks.
IsIn<CakeTaskBuilder>(CakeTaskBuilder[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CakeTaskBuilder>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CakeTaskBuilder>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
OnError(Action) CakeTaskBuilder
Adds an error handler to be executed if an exception occurs in the task.
OnError(Action<Exception, ICakeContext>) CakeTaskBuilder
Adds an error handler to be executed if an exception occurs in the task.
OnError(Action<Exception>) CakeTaskBuilder
Adds an error handler to be executed if an exception occurs in the task.
OnError<TData>(Action<Exception, ICakeContext, TData>) CakeTaskBuilder
Adds an error handler to be executed if an exception occurs in the task.
OnError<TData>(Action<Exception, TData>) CakeTaskBuilder
Adds an error handler to be executed if an exception occurs in the task.
OnError<TData>(Action<TData>) CakeTaskBuilder
Adds an error handler to be executed if an exception occurs in the task.
ReportError(Action<Exception>) 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<CakeTaskBuilder>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CakeTaskBuilder>(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
WithCriteria(bool) CakeTaskBuilder
Adds a criteria that has to be fulfilled for the task to run.
WithCriteria(bool, string) CakeTaskBuilder
Adds a criteria that has to be fulfilled for the task to run.
WithCriteria(Func<bool>) 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(Func<bool>, string) 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(Func<ICakeContext, bool>) 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(Func<ICakeContext, bool>, string) 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<TData>(Func<ICakeContext, TData, bool>) 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<TData>(Func<ICakeContext, TData, bool>, string) CakeTaskBuilder
Adds a criteria that has to be fulfilled for the task to run. The criteria is evaluated when traversal of the graph occurs.