args/com.hexagontk.args/Flag

Flag

data class Flag(val names: Set<String>, val description: String? = null, val multiple: Boolean = false, val tag: String? = null, val values: List<Boolean> = emptyList()) : Property<Boolean>

Constructors

Flag

constructor(shortName: Char? = null, name: String? = null, description: String? = null, multiple: Boolean = false)

constructor(names: Set<String>, description: String? = null, multiple: Boolean = false, tag: String? = null, values: List<Boolean> = emptyList())

Properties

description

open override val description: String? = null

multiple

open override val multiple: Boolean = false

names

open override val names: Set<String>

optional

open override val optional: Boolean = true

regex

open override val regex: Regex? = null

tag

open override val tag: String? = null

TODO To group properties (for listing or alternatives). I.e.: '|alternate|' for grouping options that are exclusive or 'Common Options' to group in help

type

open override val type: KClass<Boolean>

values

open override val values: List<Boolean>

Functions

addValue

open override fun addValue(value: String): Flag

addValues

open override fun addValues(value: Property<*>): Property<Boolean>

check

open fun check(component: String, namePattern: Regex)

typeText

open fun typeText(): String