interface CommandLine
The parser transforms a CLI (a model) into an CommandLine. This CommandLine has stored the argument and option values. Only instance of parser should create objects of this type.
Author
Clement Escoffier
abstract fun acceptMoreValues(option: Option): Boolean
Checks whether or not the given option accept more values. |
|
abstract fun allArguments(): MutableList<String> |
|
abstract fun cli(): CLI |
|
open static fun create(cli: CLI): CommandLine
Creates a command line object from the CLI. This object is intended to be used by the parser to set the argument and option values. |
|
abstract fun <T : Any> getArgumentValue(name: String): T
Gets the value of an argument with the matching name (arg name). abstract fun <T : Any> getArgumentValue(index: Int): T
Gets the value of an argument with the given index. |
|
abstract fun <T : Any> getArgumentValues(index: Int): MutableList<T>
Gets the values of an argument with the matching index. |
|
abstract 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). |
|
abstract fun <T : Any> getOptionValues(name: String): MutableList<T>
Gets the values of an option with the matching name (can be the long name, short name or arg name). |
|
abstract 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. |
|
abstract 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. |
|
abstract 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. |
|
abstract 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. |
|
abstract fun isArgumentAssigned(arg: Argument): Boolean
Checks whether or not the given argument has been assigned in the command line. |
|
abstract fun isAskingForHelp(): Boolean
Checks whether or not the user has passed a "help" option and is asking for help. |
|
abstract 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 IllegalStateException. |
|
abstract fun isOptionAssigned(option: Option): Boolean
Checks whether or not the given option has been assigned in the command line. |
|
abstract fun isSeenInCommandLine(option: Option): Boolean
Checks whether or not the given option has been seen in the user command line. |
|
abstract 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. |