CakePlatform Class

Summary

Represents the platform that Cake is running on.
Namespace
Cake.Core
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ICakePlatform"] click Interface0 "/api/Cake.Core/ICakePlatform" Type["CakePlatform"] class Type type-node

Syntax

public sealed class CakePlatform : ICakePlatform

Constructors

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

Properties

Name Value Summary
Family PlatformFamily
Gets the platform family.
Is64Bit bool
Gets a value indicating whether or not the current operative system is 64 bit.

Extension Methods

Name Value Summary
Dump<CakePlatform>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsFreeBSD() bool
Determines whether the specified platform is a FreeBSD platform.
IsIn<CakePlatform>(CakePlatform[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
IsLinux() bool
Determines whether the specified platform is a Linux platform.
IsOSX() bool
Determines whether the specified platform is a macOS platform.
IsUnix() bool
Determines whether the specified platform is a Unix platform.
IsWindows() bool
Determines whether the specified platform is a Windows platform.
NotNull<CakePlatform>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CakePlatform>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CakePlatform>(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<CakePlatform>(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