BasePathAttribute Class

Assembly
Cake.ArgumentBinder.dll
Namespace
Cake.ArgumentBinder
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["BaseAttribute"] click Base0 "/api/Cake.ArgumentBinder/BaseAttribute" Base0-->Base1["Attribute"] Type-.->Interface0["IReadOnlyArgumentAttribute"] click Interface0 "/api/Cake.ArgumentBinder/IReadOnlyArgumentAttribute" Type["BasePathAttribute"] class Type type-node Derived0["FilePathArgumentAttribute"]-->Type click Derived0 "/api/Cake.ArgumentBinder/FilePathArgumentAttribute" Derived1["DirectoryPathArgumentAttribute"]-->Type click Derived1 "/api/Cake.ArgumentBinder/DirectoryPathArgumentAttribute"

Syntax

public abstract class BasePathAttribute : BaseAttribute, IReadOnlyArgumentAttribute

Constructors

Name Summary
BasePathAttribute(string, ArgumentSource)

Properties

Name Value Summary
ArgName string
The name of the argument that is passed in via the command-line.
Inherited from BaseAttribute
ArgumentSource ArgumentSource
Where to find the argument's value.
Inherited from BaseAttribute
BaseDefaultValue object
DefaultArgumentSource ArgumentSource
Inherited from BaseAttribute
static
DefaultValue string
If not specified, the default value is null. If this is null, and Required is false, MustExist can not be true.
Description string
Description of what the argument does.
Inherited from BaseAttribute
HasSecretValue bool
Set to true if the value passed into the argument should be hidden from any print-outs to the console.
Inherited from BaseAttribute
MustExist bool
Must the file exist before executing the task? Defaulted to false. If this is true, and Required is false, DefaultValue can not be null.
Required bool
If the value is not specified, this will fail validation when this is set to true.
Inherited from BaseAttribute

Methods

Name Value Summary
ToString() string
ToString(StringBuilder) void
Appends this class's string representation to the passed in string builder object. This should be the first thing called when creating a ToString() function of all child classes.
Inherited from BaseAttribute

Extension Methods

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