com.shakelang.util.commander/com.shakelang.util.commander/CommanderOptionCreationContext

CommanderOptionCreationContext

class CommanderOptionCreationContext(source)

A class representing a context for creating a CommanderOption

Since

0.1.0

Constructors

CommanderOptionCreationContext

constructor()

Creates a new CommanderOptionCreationContext

Properties

val aliases: MutableList<String>

The aliases of the option

var defaultValue: String?

The default value of the option

var description: String?

The description of the option

var hasValue: Boolean

If the option has a value

lateinit var name: String

The name of the option

var required: Boolean

If the option is required

val shortAliases: MutableList<String>

The short aliases of the option

valueDescription

var valueDescription: String?

The description of the value

var valueName: String?

The name of the value

var valueValidator: CommanderValueValidator?

The validator of the value

Functions

fun alias(vararg aliases: String)

Add aliases to the option

fun description(description: String)

Set the description of the option

fun generate(command: CommanderCommand): CommanderOption

Set the default value of the option

fun required(required: Boolean = true)

Set the default value of the option

fun shortAlias(vararg aliases: String)

Add short aliases to the option