ArgumentValue Class

Summary

An internal ArgumentValue created from the ArgumentOrEnvironmentValue extension
Assembly
Cake.igloo15.Helper.dll
Namespace
Cake.igloo15.Helper
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["ArgumentValue"] class Type type-node

Syntax

public class ArgumentValue

Constructors

Name Summary
ArgumentValue(object, bool, bool) Constructs the argument value

Properties

Name Value Summary
IsDefault bool
True if the value is the default argument value and false if the value was passed in via an argument to script
IsPrivate bool
True if the data should be hidden from logging
Value object
The internal generic value of the argument

Methods

Name Value Summary
GetValue<T>() T
Returns the Value as a specific type

Extension Methods

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