ITaskArgumentTypeConverter Interface

Summary

An interface that allows you to identify custom ways to convert your Task Argument String(s) into a new value.
graph BT Type["ITaskArgumentTypeConverter"] class Type type-node Implementing0["TaskArgumentTypeConverter<TType>"]-.->Type click Implementing0 "/api/Cake.Sprinkles.Module.TypeConversion/TaskArgumentTypeConverter_1"

Syntax

public interface ITaskArgumentTypeConverter

Remarks

Prefer to use the TaskArgumentTypeConverter<TType> class instead.

Attributes

Type Description
NullableContextAttribute

Properties

Name Value Summary
ConversionType Type
Gets the target type for which to convert a string argument.

Methods

Name Value Summary
GetExampleInputValues() IEnumerable<string>
Gets the Usage Values for Usage Descriptions. No need to include --argument_name=. Only include values.

Extension Methods

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