FrostingSetup<TContext> Class

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 : ICakeContext

Type Parameters

Name Description
TContext The build context type.

Methods

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