ICakeReportPrinter Interface

Summary

Represents a report printer.
Namespace
Cake.Core
Implementing Types
graph BT Type["ICakeReportPrinter"] class Type type-node Implementing0["CakeReportPrinter"]-.->Type click Implementing0 "/api/Cake.Core/CakeReportPrinter" Implementing1["CakeSpectreReportPrinter"]-.->Type click Implementing1 "/api/Cake.Cli/CakeSpectreReportPrinter"

Syntax

public interface ICakeReportPrinter

Methods

Name Value Summary
Write(CakeReport) void
Writes the specified report to a target.
WriteLifeCycleStep(string, Verbosity) void
Writes the specified lifecyle steps (i.e. Setup/TearDown) to a target.
WriteSkippedStep(string, Verbosity) void
Writes the skipped step to a target.
WriteStep(string, Verbosity) void
Writes the specified step to a target.

Extension Methods

Name Value Summary
Dump<ICakeReportPrinter>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ICakeReportPrinter>(ICakeReportPrinter[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ICakeReportPrinter>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ICakeReportPrinter>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ICakeReportPrinter>(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<ICakeReportPrinter>(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
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin