CommanderArgument

class CommanderArgument(val command: CommanderCommand, val name: String, val description: String? = null, val required: Boolean = false, val defaultValue: String? = null, val valueName: String? = null, val valueDescription: String? = null, val valueValidator: CommanderValueValidator? = null)(source)

A class representing an argument of a CommanderCommand

Since

0.1.0

Parameters

command

The CommanderCommand this argument belongs to

name

The name of the argument

description

The description of the argument

required

If the argument is required

defaultValue

The default value of the argument

valueName

The name of the argument's value

valueDescription

The description of the argument's value

valueValidator

The CommanderValueValidator of the value of the argument

See also

Constructors

Link copied to clipboard
constructor(command: CommanderCommand, name: String, description: String? = null, required: Boolean = false, defaultValue: String? = null, valueName: String? = null, valueDescription: String? = null, valueValidator: CommanderValueValidator? = null)

Properties

Link copied to clipboard

The CommanderCommand this argument belongs to

Link copied to clipboard
val defaultValue: String? = null

The default value of the argument

Link copied to clipboard
val description: String? = null

The description of the argument

Link copied to clipboard

The name of the argument

Link copied to clipboard
val required: Boolean = false

If the argument is required

Link copied to clipboard

The description of the argument's value

Link copied to clipboard
val valueName: String? = null

The name of the argument's value

Link copied to clipboard

The CommanderValueValidator of the value of the argument

Functions

Link copied to clipboard

Get the usage of the argument