CakeArguments Class

Summary

Represents arguments passed to the executing script.
Namespace
Cake.Core
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ICakeArguments"] click Interface0 "/api/Cake.Core/ICakeArguments" Type["CakeArguments"] class Type type-node

Syntax

public sealed class CakeArguments : ICakeArguments

Constructors

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

Methods

Name Value Summary
GetArguments() IDictionary<string, ICollection<string>>
Gets all command line arguments.
GetArguments(string) ICollection<string>
Gets all values for an argument.
HasArgument(string) bool
Determines whether or not the specified argument exist.

Extension Methods

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