IReadOnlyArgumentAttribute Interface

graph BT Type["IReadOnlyArgumentAttribute"] class Type type-node Implementing0["BaseAttribute"]-.->Type click Implementing0 "/api/Cake.ArgumentBinder/BaseAttribute" Implementing1["BooleanArgumentAttribute"]-.->Type click Implementing1 "/api/Cake.ArgumentBinder/BooleanArgumentAttribute" Implementing2["BasePathAttribute"]-.->Type click Implementing2 "/api/Cake.ArgumentBinder/BasePathAttribute" Implementing3["EnumArgumentAttribute"]-.->Type click Implementing3 "/api/Cake.ArgumentBinder/EnumArgumentAttribute" Implementing4["FilePathArgumentAttribute"]-.->Type click Implementing4 "/api/Cake.ArgumentBinder/FilePathArgumentAttribute" Implementing5["StringArgumentAttribute"]-.->Type click Implementing5 "/api/Cake.ArgumentBinder/StringArgumentAttribute" Implementing6["IntegerArgumentAttribute"]-.->Type click Implementing6 "/api/Cake.ArgumentBinder/IntegerArgumentAttribute" Implementing7["DirectoryPathArgumentAttribute"]-.->Type click Implementing7 "/api/Cake.ArgumentBinder/DirectoryPathArgumentAttribute"

Syntax

public interface IReadOnlyArgumentAttribute

Properties

Name Value Summary
ArgName string
The argument name
Description string
Description of what the argument does.
HasSecretValue bool
Set to true if the value passed into the argument should be hidden from any print-outs to the console.
Required bool
If the value is not specified, this will fail validation.

Extension Methods

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