arg

open fun <R : Any> arg(displayName: Key, description: Key, converter: SingleConverter<R>): SingleConverter<R>

Add a SingleConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.


open fun <R : Any> arg(displayName: Key, description: Key, converter: DefaultingConverter<R>): DefaultingConverter<R>

Add a DefaultingConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.


open fun <R : Any> arg(displayName: Key, description: Key, converter: OptionalConverter<R>): OptionalConverter<R>

Add an OptionalConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.


open fun <R : Any> arg(displayName: Key, description: Key, converter: ListConverter<R>): ListConverter<R>

Add a ListConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.


open fun <R : Any> arg(displayName: Key, description: Key, converter: CoalescingConverter<R>): CoalescingConverter<R>

Add a CoalescingConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.


open fun <R : Any> arg(displayName: Key, description: Key, converter: DefaultingCoalescingConverter<R>): DefaultingCoalescingConverter<R>

Add a DefaultingCoalescingConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.


open fun <R : Any> arg(displayName: Key, description: Key, converter: OptionalCoalescingConverter<R>): OptionalCoalescingConverter<R>

Add an OptionalCoalescingConverter argument to this set of arguments.

This is typically used indirectly, via an extension function that wraps it. It returns the converter, which is intended to be used as a property delegate.

Return

Argument converter to use as a delegate.

Parameters

displayName

Display name used in help messages and as the key for keyword arguments.

converter

Converter instance to add.