com.shakelang.util.commander/com.shakelang.util.commander/CommanderArgumentCreationContext

CommanderArgumentCreationContext

class CommanderArgumentCreationContext(source)

A class representing a context for creating a CommanderArgument

Since

0.1.0

Constructors

CommanderArgumentCreationContext

constructor()

Properties

var defaultValue: String?

The default value of the argument

var description: String?

The description of the argument

lateinit var name: String

The name of the argument

var required: Boolean

If the argument is required

valueDescription

var valueDescription: String?

The description of the argument's value

var valueName: String?

The name of the argument's value

var valueValidator: CommanderValueValidator?

The CommanderValueValidator of the value of the argument

Functions

fun description(description: String)

Add description to the argument

fun generate(command: CommanderCommand): CommanderArgument

Generate the CommanderArgument from the context

fun required(required: Boolean = true)

Set the default value of the argument