CakeReport Class

Summary

Contains information about tasks that were executed in a script.
Namespace
Cake.Core
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IEnumerable<CakeReportEntry>"] Type-.->Interface1["IEnumerable"] Type["CakeReport"] class Type type-node

Syntax

public sealed class CakeReport : IEnumerable<CakeReportEntry>, IEnumerable

Constructors

Name Summary
CakeReport() Initializes a new instance of the CakeReport class.

Properties

Name Value Summary
IsEmpty bool
Gets a value indicating whether the report is empty.

Methods

Name Value Summary
Add(string, CakeReportEntryCategory, TimeSpan) void
Adds a task result to the report with a specific category.
Add(string, CakeReportEntryCategory, TimeSpan, CakeTaskExecutionStatus) void
Adds a task result to the report.
Add(string, TimeSpan) void
Adds a task result to the report.
AddDelegated(string, TimeSpan) void
Adds a delegated task result to the report.
AddSkipped(string) void
Adds a skipped task result to the report.
GetEnumerator() IEnumerator<CakeReportEntry>
Returns an enumerator that iterates through the collection.

Extension Methods

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