args/com.hexagontk.args/Command

Command

data class Command(val name: String, val title: String? = null, val description: String? = null, val properties: Set<Property<*>> = emptySet(), val subcommands: Set<Command> = emptySet())

A program can have multiple commands with their own set of options and positional parameters.

TODO Support aliases

Constructors

constructor(name: String, title: String? = null, description: String? = null, properties: Set<Property<*>> = emptySet(), subcommands: Set<Command> = emptySet())

Properties

val description: String? = null

val flags: Set<Flag>

val name: String

val options: Set<Option<*>>

val optionsMap: Map<String, Option<*>>

val parameters: Set<Parameter<*>>

val parametersMap: Map<String, Parameter<*>>

val properties: Set<Property<*>>

val propertiesMap: Map<String, Property<*>>

val subcommands: Set<Command>

val subcommandsMap: Map<String, Command>

val title: String? = null

Functions

fun contains(flag: Flag, args: Iterable<String>): Boolean

fun findCommand(args: Iterable<String>): Command

fun parse(args: List<String>): Command

fun <T : Any> propertyValue(name: String): T

propertyValueOrNull

fun <T : Any> propertyValueOrNull(name: String): T?

fun <T : Any> propertyValues(name: String): List<T>