CakeEnvironment Class

Summary

Represents the environment Cake operates in.
Namespace
Cake.Core
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ICakeEnvironment"] click Interface0 "/api/Cake.Core/ICakeEnvironment" Type["CakeEnvironment"] class Type type-node

Syntax

public sealed class CakeEnvironment : ICakeEnvironment

Constructors

Name Summary
CakeEnvironment(ICakePlatform, ICakeRuntime, ICakeLog) Initializes a new instance of the CakeEnvironment class.

Properties

Name Value Summary
ApplicationRoot DirectoryPath
Gets the application root path.
Platform ICakePlatform
Gets the platform Cake is running on.
Runtime ICakeRuntime
Gets the runtime Cake is running in.
WorkingDirectory DirectoryPath
Gets or sets the working directory.

Methods

Name Value Summary
GetApplicationRoot() DirectoryPath
Gets the application root path.
GetEnvironmentVariable(string) string
Gets an environment variable.
GetEnvironmentVariables() IDictionary<string, string>
Gets all environment variables.
GetSpecialPath(SpecialPath) DirectoryPath
Gets a special path.
Is64BitOperativeSystem() bool
Gets whether or not the current operative system is 64 bit.
IsUnix() bool
Determines whether the current machine is running Unix.

Extension Methods

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