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

Summary

The abstract TaskArgumentTypeConverter<TType>, assists in building a ITaskArgumentTypeConverter.

Assembly

Cake.Sprinkles.Module.dll

Namespace

Cake.Sprinkles.Module.TypeConversion

Interfaces

ITaskArgumentTypeConverter

Base Types

TypeConverter

graph BT Type-->Base0["TypeConverter"] Type-.->Interface0["ITaskArgumentTypeConverter"] click Interface0 "/api/Cake.Sprinkles.Module.TypeConversion/ITaskArgumentTypeConverter" Type["TaskArgumentTypeConverter<TType>"] class Type type-node

Syntax

public abstract class TaskArgumentTypeConverter<TType> : TypeConverter, ITaskArgumentTypeConverter

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Type Parameters

Name	Description
TType	The target type used for converting a string.

Constructors

Name	Summary
TaskArgumentTypeConverter()

Properties

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

Methods

Name	Value	Summary
CanConvertFrom(ITypeDescriptorContext, Type)	bool	Receives a value indicating whether this `System.ComponentModel.TypeConverter` can convert from a particular `Type`.
CanConvertTo(ITypeDescriptorContext, Type)	bool	Receives a value indicating whether this `System.ComponentModel.TypeConverter` can convert to a `TaskArgument` from our `Type`.
ConvertFrom(ITypeDescriptorContext, CultureInfo, object)	object	Converts from a `TaskArgument` into a new type.
ConvertType(TaskArgument, CultureInfo)	TType	Converts a nullable string to a value of type TType
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<TaskArgumentTypeConverter<TType>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<TaskArgumentTypeConverter<TType>>(TaskArgumentTypeConverter<TType>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<TaskArgumentTypeConverter<TType>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<TaskArgumentTypeConverter<TType>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<TaskArgumentTypeConverter<TType>>(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<TaskArgumentTypeConverter<TType>>(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	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

TaskArgumentTypeConverter<TType> Class