com.shakelang.util.commander/com.shakelang.util.commander/CommanderCommand

CommanderCommand

class CommanderCommand(val parent: CommanderCommand? = null, val name: String, val aliases: Array<String> = arrayOf(), val description: String? = null, val arguments: MutableList<CommanderArgument> = mutableListOf(), val options: MutableList<CommanderOption> = mutableListOf(), val commands: MutableList<CommanderCommand> = mutableListOf(), var action: CommanderCommandAction? = null)(source)

A class that represents a command line interface command

Since

0.1.0

Parameters

parent

The parent command

name

The name of the command

aliases

The aliases of the command

description

The description of the command

arguments

The arguments of the command

options

The options of the command

commands

The subcommands of the command

action

The action of the command

Constructors

CommanderCommand

constructor(parent: CommanderCommand? = null, name: String, aliases: Array<String> = arrayOf(), description: String? = null, arguments: MutableList<CommanderArgument> = mutableListOf(), options: MutableList<CommanderOption> = mutableListOf(), commands: MutableList<CommanderCommand> = mutableListOf(), action: CommanderCommandAction? = null)

Properties

var action: CommanderCommandAction?

The action of the command

val aliases: Array<String>

The aliases of the command

val arguments: MutableList<CommanderArgument>

The arguments of the command

val commands: MutableList<CommanderCommand>

The subcommands of the command

val description: String? = null

The description of the command

val name: String

The name of the command

val options: MutableList<CommanderOption>

The options of the command

val parent: CommanderCommand? = null

The parent command (or null if this is the root command)

Functions

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

Create a new argument

fun execute(args: Array<String>): CommanderParseResult

Execute the command

getArgumentByName

fun getArgumentByName(name: String): CommanderArgument?

Get an argument by its name

fun getFullUsage(): String

Get the full usage of the command

getOptionByName

fun getOptionByName(name: String): CommanderOption?

Get an option by its name (or alias)

getOptionByShortName

fun getOptionByShortName(name: String): CommanderOption?

Get an option by its short alias

fun getUsage(): String

Get the usage of the command

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): CommanderCommand

Get an argument by its name

fun parse(args: Array<String>): CommanderParseResult

Parse an array of arguments

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

Create a new subcommand