FrostingLifetime<TContext> Class

Summary

Base class for the Setup/Teardown logic of a Cake run.
Namespace
Cake.Frosting
Interfaces
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type-.->Interface0["IFrostingLifetime"] click Interface0 "/api/Cake.Frosting/IFrostingLifetime" Type-.->Interface1["IFrostingSetup"] click Interface1 "/api/Cake.Frosting/IFrostingSetup" Type-.->Interface2["IFrostingTeardown"] click Interface2 "/api/Cake.Frosting/IFrostingTeardown" Type["FrostingLifetime<TContext>"] class Type type-node Derived0["FrostingLifetime"]-->Type click Derived0 "/api/Cake.Frosting/FrostingLifetime"

Syntax

public abstract class FrostingLifetime<TContext> : IFrostingLifetime, IFrostingSetup, 
    IFrostingTeardown
    where TContext : ICakeContext

Type Parameters

Name Description
TContext The type of the context.

Methods

Name Value Summary
Setup(TContext) void
This method is executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed.
Teardown(TContext, ITeardownContext) void
This method is executed after all tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.

Extension Methods

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

See Also