ArgumentSource Class

Summary

Where the source of the argument's value is.
Assembly
Cake.ArgumentBinder.dll
Namespace
Cake.ArgumentBinder
Base Types
  • Enum
graph BT Type-->Base0["Enum"] Type["ArgumentSource"] class Type type-node

Syntax

public sealed class ArgumentSource : Enum

Fields

Name Constant Value Summary
CommandLine 0
The argument's value is from the command line only. This is the default behavior.
static
CommandLineThenEnvironmentVariable 2
The argument's value comes from the command line. However, if the value does not exist on the command line, it will then come from an environment variable instead.
static
EnvironmentVariable 1
The argument's value comes from an environment variable only.
static
EnvironmentVariableThenCommandLine 3
The argument's value comes from an environment variable. However, if the value does not exist as an environment variable, it will then come from the command line as a backup.
static
value__

Extension Methods

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