CakeOptions Class

Summary

The options that determines how the application should behave.
Namespace
Cake
Base Types
  • object
graph BT Type-->Base0["object"] Type["CakeOptions"] class Type type-node

Syntax

public sealed class CakeOptions

Constructors

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

Properties

Name Value Summary
Arguments IDictionary<string, string>
Gets the script arguments.
Bootstrap bool
Gets or sets a value indicating whether to bootstrap Cake modules.
Exclusive bool
Gets or sets a value indicating whether or not to use the target exclusively.
HasError bool
Gets or sets a value indicating whether an error occurred during parsing.
PerformDebug bool
Gets or sets a value indicating whether to debug script.
PerformDryRun bool
Gets or sets a value indicating whether to perform a dry run.
Script FilePath
Gets or sets the build script.
ShowDescription bool
Gets or sets a value indicating whether to show task descriptions.
ShowHelp bool
Gets or sets a value indicating whether to show help.
ShowInfo bool
Gets or sets a value indicating whether to show additional information.
ShowTree bool
Gets or sets a value indicating whether to show the task dependency tree
ShowVersion bool
Gets or sets a value indicating whether to show version information.
Verbosity Verbosity
Gets or sets the output verbosity.

Extension Methods

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