Argos/onl.ycode.argos/NonNullableOptionBuilder

NonNullableOptionBuilder

class NonNullableOptionBuilder<T : Any>(val delegate: OptionBuilder<T?>) : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, T>> (source)

Builder for non-nullable command-line options. This type is returned by .default() and .required() to ensure type safety. It delegates most operations to the underlying OptionBuilder while ensuring type safety.

Constructors

constructor(delegate: OptionBuilder<T?>)

Properties

delegate

val delegate: OptionBuilder<T?>

Functions

atLeastOneWith

fun atLeastOneWith(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Creates an "at least one" constraint with other options. At least one option from this group (including this option) must be provided.

atMostOneWith

fun atMostOneWith(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Creates an "at most one" constraint with other options. At most one option from this group (including this option) may be provided.

conflictsWith

fun conflictsWith(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Specifies that this option conflicts with other options. If this option is provided along with any of the conflicting options, parsing will fail with an error.

double

fun NonNullableOptionBuilder<String>.double(): NonNullableOptionBuilder<Double>

Converts non-nullable string option to non-nullable double option.

enum

inline fun <E : Enum<E>> NonNullableOptionBuilder<String>.enum(aliases: Map<String, E> = emptyMap(), ignoreCase: Boolean = true): NonNullableOptionBuilder<E>

Converts non-nullable string option to non-nullable enum option.

exactlyOneWith

fun exactlyOneWith(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Creates an "exactly one" constraint with other options. Exactly one option from this group (including this option) must be provided.

float

fun NonNullableOptionBuilder<String>.float(): NonNullableOptionBuilder<Float>

Converts non-nullable string option to non-nullable float option.

fromEnv

fun fromEnv(name: String): NonNullableOptionBuilder<T>

Configures this option to read its value from an environment variable. If the command-line option is not provided, the specified environment variable will be checked for a value.

help

fun help(text: String): NonNullableOptionBuilder<T>

Sets the help text for this option. The help text is displayed when the user requests help information.

hidden

fun hidden(): NonNullableOptionBuilder<T>

Marks this option as hidden from help output. Hidden options are not displayed in help text but remain functional.

int

fun NonNullableOptionBuilder<String>.int(): NonNullableOptionBuilder<Int>

Converts non-nullable string option to non-nullable integer option.

long

fun NonNullableOptionBuilder<String>.long(): NonNullableOptionBuilder<Long>

Converts non-nullable string option to non-nullable long option.

map

fun <R : Any> map(desc: String? = null, f: (T) -> R?): OptionBuilder<R?>

Maps the parsed value, allowing nullable output.

fun <R : Any> map(desc: String? = null, f: (T) -> R): NonNullableOptionBuilder<R>

Maps the parsed value using the specified transformation function. Preserves non-nullable type when transformation returns non-null.

negatable

fun NonNullableOptionBuilder<Boolean>.negatable(prefix: String? = null): NonNullableOptionBuilder<Boolean>

Makes a non-nullable boolean option negatable with custom prefix.

oneOf

fun NonNullableOptionBuilder<String>.oneOf(vararg allowed: String, ignoreCase: Boolean = true): NonNullableOptionBuilder<String>

Restricts non-nullable string option to one of the specified allowed values.

onlyInDomains

fun onlyInDomains(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Restricts this option to only be available in specific domains. When specified, this option will only be recognized when one of the referenced domains is active.

onValue

fun onValue(callback: (T) -> Unit): NonNullableOptionBuilder<T>

Registers a callback to be executed when this option's value is found during parsing. The callback receives the converted non-null value and is executed after all parsing and validation completes.

provideDelegate

open operator override fun provideDelegate(thisRef: Arguments, property: KProperty<*>): ReadOnlyProperty<Arguments, T>

Provides the property delegate implementation for non-nullable options. This method is called automatically by Kotlin's property delegation system. It delegates to the underlying OptionBuilder but ensures the returned value is non-null.

requireIfAllPresent

fun requireIfAllPresent(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Makes this option required if all of the referenced options are present. This creates a conditional requirement where providing all of the trigger options makes this option mandatory.

requireIfAnyPresent

fun requireIfAnyPresent(vararg refs: KProperty<*>): NonNullableOptionBuilder<T>

Makes this option required if any of the referenced options are present. This creates a conditional requirement where providing any of the trigger options makes this option mandatory.

requireIfValue

fun <U> requireIfValue(ref: KProperty<U>, predicate: (U?) -> Boolean): NonNullableOptionBuilder<T>

Makes this option required if the referenced option's value matches the predicate. This creates a value-based conditional requirement.

validate

fun validate(vararg validations: Pair<String, (T) -> Boolean>): NonNullableOptionBuilder<T>

Adds multiple validations for this option's value. All validations are applied to the parsed non-null value.

fun validate(message: String = "Invalid value for @name: @value", predicate: (T) -> Boolean): NonNullableOptionBuilder<T>

Adds validation for this option's value. The validation is applied to the parsed non-null value.