This content is part of a third party extension that is not supported by the Cake project.

Summary

An interface that allows you to identify custom ways to convert your Task Argument String(s) into a new value.

Assembly

Cake.Sprinkles.Module.dll

Namespace

Cake.Sprinkles.Module.TypeConversion

Implementing Types

TaskArgumentTypeConverter<TType>

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. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<ITaskArgumentTypeConverter>(ITaskArgumentTypeConverter[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<ITaskArgumentTypeConverter>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<ITaskArgumentTypeConverter>(string)	void	From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<ITaskArgumentTypeConverter>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<ITaskArgumentTypeConverter>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	From StringExtensions Requires the Cake.Issues addin