ICakeLog Interface

Summary

Represents a log.
Namespace
Cake.Core.Diagnostics
Implementing Types
graph BT Type["ICakeLog"] class Type type-node Implementing0["NullLog"]-.->Type click Implementing0 "/api/Cake.Core.Diagnostics/NullLog" Implementing1["FakeLog"]-.->Type click Implementing1 "/api/Cake.Testing/FakeLog" Implementing2["CakeBuildLog"]-.->Type click Implementing2 "/api/Cake.Core.Diagnostics/CakeBuildLog"

Syntax

public interface ICakeLog

Properties

Name Value Summary
Verbosity Verbosity
Gets or sets the verbosity.

Methods

Name Value Summary
Write(Verbosity, LogLevel, string, object[]) void
Writes the text representation of the specified array of objects to the log using the specified verbosity, log level and format information.

Extension Methods

Name Value Summary
Debug(LogAction) void
Writes a debug message to the log using the specified log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Debug(object) void
Writes a debug message to the log using the specified value.
Debug(string) void
Writes a debug message to the log using the specified string value.
Debug(string, object[]) void
Writes a debug message to the log using the specified format information.
Debug(Verbosity, LogAction) void
Writes a debug message to the log using the specified verbosity and log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Debug(Verbosity, string, object[]) void
Writes a debug message to the log using the specified verbosity and format information.
DiagnosticVerbosity() IDisposable
Sets the log verbosity to diagnostic and returns a disposable that restores the log verbosity on dispose.
Dump<ICakeLog>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Error(LogAction) void
Writes an error message to the log using the specified log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Error(object) void
Writes an error message to the log using the specified value.
Error(string) void
Writes an error message to the log using the specified string value.
Error(string, object[]) void
Writes an error message to the log using the specified format information.
Error(Verbosity, LogAction) void
Writes an error message to the log using the specified verbosity and log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Error(Verbosity, string, object[]) void
Writes an error message to the log using the specified verbosity and format information.
Information(LogAction) void
Writes an informational message to the log using the specified log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Information(object) void
Writes an informational message to the log using the specified value.
Information(string) void
Writes an informational message to the log using the specified string value.
Information(string, object[]) void
Writes an informational message to the log using the specified format information.
Information(Verbosity, LogAction) void
Writes an informational message to the log using the specified verbosity and log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Information(Verbosity, string, object[]) void
Writes an informational message to the log using the specified verbosity and format information.
IsIn<ICakeLog>(ICakeLog[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
MinimalVerbosity() IDisposable
Sets the log verbosity to minimal and returns a disposable that restores the log verbosity on dispose.
NormalVerbosity() IDisposable
Sets the log verbosity to normal and returns a disposable that restores the log verbosity on dispose.
NotNull<ICakeLog>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ICakeLog>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
QuietVerbosity() IDisposable
Sets the log verbosity to quiet and returns a disposable that restores the log verbosity on dispose.
ThrowIfNull<ICakeLog>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ICakeLog>(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
Verbose(LogAction) void
Writes a verbose message to the log using the specified log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Verbose(object) void
Writes a verbose message to the log using the specified value.
Verbose(string) void
Writes a verbose message to the log using the specified string value.
Verbose(string, object[]) void
Writes a verbose message to the log using the specified format information.
Verbose(Verbosity, LogAction) void
Writes a verbose message to the log using the specified verbosity and log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Verbose(Verbosity, string, object[]) void
Writes a verbose message to the log using the specified verbosity and format information.
VerboseVerbosity() IDisposable
Sets the log verbosity to verbose and returns a disposable that restores the log verbosity on dispose.
Warning(LogAction) void
Writes a warning message to the log using the specified log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Warning(object) void
Writes an warning message to the log using the specified value.
Warning(string) void
Writes an warning message to the log using the specified string value.
Warning(string, object[]) void
Writes a warning message to the log using the specified format information.
Warning(Verbosity, LogAction) void
Writes a warning message to the log using the specified verbosity and log message action. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
Warning(Verbosity, string, object[]) void
Writes a warning message to the log using the specified verbosity and format information.
WithVerbosity(Verbosity) IDisposable
Sets the log verbosity as specified and returns a disposable that restores the log verbosity on dispose.
Write(Verbosity, LogLevel, LogAction) void
Writes a message to the log using the specified verbosity, log level and log action delegate. Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.