com.shakelang.util.commander/com.shakelang.util.commander/CommanderCommandCreationContext

CommanderCommandCreationContext

class CommanderCommandCreationContext(source)

Context for creating a command

Since

0.1.0

Constructors

CommanderCommandCreationContext

constructor()

Properties

var action: CommanderCommandAction?

The action of the command

val aliases: MutableList<String>

The aliases of the command

val arguments: MutableList<(CommanderCommand) -> CommanderArgument>

The arguments of the command

val commands: MutableList<(CommanderCommand) -> CommanderCommand>

The subcommands of the command

var description: String?

The description of the command

lateinit var name: String

The name of the command

val options: MutableList<(CommanderCommand) -> CommanderOption>

The options of the command

Functions

fun action(action: CommanderCommandAction)

Add an action to the command

fun alias(vararg aliases: String)

Add an alias to the command

fun argument(cliArgument: CommanderArgument)

fun argument(init: CliArgumentInit)

fun argument(name: String, description: String? = null, required: Boolean = false, defaultValue: String? = null, valueName: String? = null, valueDescription: String? = null, valueValidator: CommanderValueValidator? = null)

Add an argument to the command

fun description(description: String)

Add description to the command

fun generate(parent: CommanderCommand?): CommanderCommand

Generate the command

fun option(cliOption: CommanderOption)

fun option(init: CommanderOptionInit)

fun option(name: String, aliases: Array<String> = arrayOf(), shortAliases: Array<String> = arrayOf(), description: String? = null, required: Boolean = false, hasValue: Boolean = false, defaultValue: String? = null, valueName: String? = null, valueDescription: String? = null, valueValidator: CommanderValueValidator? = null)

Add an option to the command

fun subcommand(cliCommand: CommanderCommand)

fun subcommand(init: CommanderCommandInit)

fun subcommand(name: String, aliases: Array<String> = arrayOf(), description: String? = null, action: CommanderCommandAction? = null, init: CommanderCommandInit? = null)

Add a subcommand to the command