vertx / io.vertx.reactivex.core.cli / CommandLine

CommandLine

open class CommandLine

The parser transforms a CLI (a model) into an io.vertx.reactivex.core.cli.CommandLine. This io.vertx.reactivex.core.cli.CommandLine has stored the argument and option values. Only instance of parser should create objects of this type. NOTE: This class has been automatically generated from the io.vertx.core.cli.CommandLine non RX-ified interface using Vert.x codegen.

Constructors

<init>

CommandLine(delegate: CommandLine)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<CommandLine>

Functions

acceptMoreValues

open fun acceptMoreValues(option: Option): Boolean

Checks whether or not the given option accept more values.

allArguments

open fun allArguments(): MutableList<String>

cli

open fun cli(): CLI

create

open static fun create(cli: CLI): CommandLine

Creates a command line object from the io.vertx.reactivex.core.cli.CLI. This object is intended to be used by the parser to set the argument and option values.

equals

open fun equals(other: Any?): Boolean

getArgumentValue

open fun <T : Any> getArgumentValue(name: String): T

Gets the value of an argument with the matching name (arg name).

open fun <T : Any> getArgumentValue(index: Int): T

Gets the value of an argument with the given index.

getDelegate

open fun getDelegate(): CommandLine

getOptionValue

open fun <T : Any> getOptionValue(name: String): T

Gets the value of an option with the matching name (can be the long name, short name or arg name).

getRawValueForArgument

open fun getRawValueForArgument(arg: Argument): String

Gets the raw value of the given argument. Raw values are the values as given in the user command line.

getRawValueForOption

open fun getRawValueForOption(option: Option): String

Gets the raw value of the given option. Raw values are the values as given in the user command line.

getRawValues

open fun getRawValues(option: Option): MutableList<String>

Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

getRawValuesForArgument

open fun getRawValuesForArgument(argument: Argument): MutableList<String>

Gets the raw values of the given argument. Raw values are simple "String", not converted to the argument type.

getRawValuesForOption

open fun getRawValuesForOption(option: Option): MutableList<String>

Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

hashCode

open fun hashCode(): Int

isArgumentAssigned

open fun isArgumentAssigned(arg: Argument): Boolean

Checks whether or not the given argument has been assigned in the command line.

isAskingForHelp

open fun isAskingForHelp(): Boolean

Checks whether or not the user has passed a "help" option and is asking for help.

isFlagEnabled

open fun isFlagEnabled(name: String): Boolean

Gets the value of an option marked as a flag. Calling this method an a non-flag option throws an java.lang.IllegalStateException.

isOptionAssigned

open fun isOptionAssigned(option: Option): Boolean

Checks whether or not the given option has been assigned in the command line.

isSeenInCommandLine

open fun isSeenInCommandLine(option: Option): Boolean

Checks whether or not the given option has been seen in the user command line.

isValid

open fun isValid(): Boolean

Checks whether or not the command line is valid, i.e. all constraints from arguments and options have been satisfied. This method is used when the parser validation is disabled.

newInstance

open static fun newInstance(arg: CommandLine): CommandLine

toString

open fun toString(): String