args/com.hexagontk.args/Option

Option

data class Option<T : Any>(val type: KClass<T>, val names: Set<String>, val description: String? = null, val regex: Regex? = null, val optional: Boolean = true, val multiple: Boolean = false, val tag: String? = null, val values: List<T> = emptyList()) : Property<T>

Constructors

Option

constructor(type: KClass<T>, shortName: Char? = null, name: String? = null, description: String? = null, regex: Regex? = null, optional: Boolean = true, multiple: Boolean = false, tag: String? = null)

constructor(type: KClass<T>, shortName: Char? = null, name: String? = null, description: String? = null, regex: Regex? = null, tag: String? = null, values: List<T>)

constructor(type: KClass<T>, shortName: Char? = null, name: String? = null, description: String? = null, regex: Regex? = null, tag: String? = null, value: T)

constructor(type: KClass<T>, names: Set<String>, description: String? = null, regex: Regex? = null, optional: Boolean = true, multiple: Boolean = false, tag: String? = null, values: List<T> = emptyList())

Types

Companion

object Companion

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<T>

values

open override val values: List<T>

Functions

addValue

open override fun addValue(value: String): Option<T>

addValues

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

check

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

typeText

open fun typeText(): String