OptionCallTransformContext

class OptionCallTransformContext(val name: String, val option: Option, val context: Context) : Option

A receiver for options transformers.

Constructors

Link copied to clipboard
fun OptionCallTransformContext(name: String, option: Option, context: Context)

Functions

Link copied to clipboard
fun fail(message: String): Nothing

Throw an exception indicating that an invalid value was provided.

Link copied to clipboard
open override fun finalize(context: Context, invocations: List<OptionParser.Invocation>)

Called after this command's argv is parsed to transform and store the option's value.

Link copied to clipboard
fun message(message: String)

Issue a message that can be shown to the user

Link copied to clipboard
open override fun metavar(context: Context): String?

A name representing the values for this option that can be displayed to the user.

Link copied to clipboard

Information about this option for the help output.

Link copied to clipboard
open override fun postValidate(context: Context)

Called after all of a command's parameters have been finalized to perform validation of the final value.

Link copied to clipboard
inline fun require(value: Boolean, lazyMessage: () -> String = { "" })

If value is false, call fail with the output of lazyMessage

Properties

Link copied to clipboard

Optional set of strings to use when the user invokes shell autocomplete on a value for this option.

Link copied to clipboard
Link copied to clipboard
open override val helpTags: Map<String, String>

Extra information about this option to pass to the help formatter.

Link copied to clipboard
open override val hidden: Boolean

If true, this option should not appear in help output.

Link copied to clipboard

The name that was used to invoke this option.

Link copied to clipboard
open override val names: Set<String>

The names that can be used to invoke this option. They must start with a punctuation character.

Link copied to clipboard
open override val nvalues: Int

The number of values that must be given to this option.

Link copied to clipboard

The option that was invoked

Link copied to clipboard
open override val optionHelp: String

The description of this option, usually a single line.

Link copied to clipboard
open override val parser: OptionParser

The parser for this option's values.

Link copied to clipboard
open override val secondaryNames: Set<String>

Names that can be used for a secondary purpose, like disabling flag options.

Link copied to clipboard
open override val valueSourceKey: String?

Optional explicit key to use when looking this option up from a ValueSource