CakeConfiguration Class

Summary

The default implementation of the Cake configuration.
Namespace
Cake.Core.Configuration
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ICakeConfiguration"] click Interface0 "/api/Cake.Core.Configuration/ICakeConfiguration" Type["CakeConfiguration"] class Type type-node

Syntax

public sealed class CakeConfiguration : ICakeConfiguration

Constructors

Name Summary
CakeConfiguration(IDictionary<string, string>) Initializes a new instance of the CakeConfiguration class.

Methods

Name Value Summary
GetValue(string) string
Gets the value that corresponds to the specified key.

Extension Methods

Name Value Summary
Dump<CakeConfiguration>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
GetModulePath(DirectoryPath, ICakeEnvironment) DirectoryPath
Gets the module directory path.
GetToolPath(DirectoryPath, ICakeEnvironment) DirectoryPath
Gets the tool directory path.
IsIn<CakeConfiguration>(CakeConfiguration[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CakeConfiguration>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<CakeConfiguration>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<CakeConfiguration>(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<CakeConfiguration>(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