KetraTermTerminalArgumentSpec
data class TerminalArgumentSpec @JvmOverloads constructor(val name: String = "", val description: String = "", val isOptional: Boolean = false, val isVariadic: Boolean = false, val pathKind: TerminalPathArgumentKind = TerminalPathArgumentKind.NONE, val valueCandidates: List<String> = emptyList(), val valueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, val hiddenPathPolicy: TerminalHiddenPathPolicy = TerminalHiddenPathPolicy.DEFAULT)
Declarative metadata for one ordered positional command argument.
Throws
if valueCandidates contains a blank value.
Constructors
Link copied to clipboard
constructor(name: String = "", description: String = "", isOptional: Boolean = false, isVariadic: Boolean = false, pathKind: TerminalPathArgumentKind = TerminalPathArgumentKind.NONE, valueCandidates: List<String> = emptyList(), valueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, hiddenPathPolicy: TerminalHiddenPathPolicy = TerminalHiddenPathPolicy.DEFAULT)
Properties
Link copied to clipboard
short explanation shown with static value candidates.
Link copied to clipboard
hidden-entry policy used when pathKind accepts a path.
Link copied to clipboard
whether callers may omit this argument.
Link copied to clipboard
whether this declaration applies to every remaining positional argument after its ordinal position.
Link copied to clipboard
filesystem path category accepted by this argument.
Link copied to clipboard
bounded static values accepted by this argument.
Link copied to clipboard
dynamic host-owned value domain accepted by this argument.