Argos/onl.ycode.argos/OptionListBuilder

OptionListBuilder

class OptionListBuilder<T : Any> : CollectionOptionBuilder<T, List<T>> (source)

Builder for creating command-line list options with various configurations and constraints.

This class provides a fluent API for defining list options that can collect multiple values, including type refinements, constraints, environment variable support, and help text.

Functions

arity

fun arity(n: Int): ArityListOptionBuilder<T>

Creates an arity option for lists where each invocation consumes exactly n values.

atLeast

open override fun atLeast(n: Int): OptionListBuilder<T>

Requires this list option to have at least the specified number of values. This constraint is validated after parsing completes.

atLeastOneWith

open override fun atLeastOneWith(vararg refs: KProperty<*>): OptionListBuilder<T>

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

atMostOneWith

open override fun atMostOneWith(vararg refs: KProperty<*>): OptionListBuilder<T>

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

conflictsWith

open override fun conflictsWith(vararg refs: KProperty<*>): OptionListBuilder<T>

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

exactlyOneWith

open override fun exactlyOneWith(vararg refs: KProperty<*>): OptionListBuilder<T>

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

help

fun help(text: String): CollectionOptionBuilder<T, List<T>>

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

hidden

fun hidden(): CollectionOptionBuilder<T, List<T>>

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

onlyInDomains

open override fun onlyInDomains(vararg refs: KProperty<*>): OptionListBuilder<T>

Restricts this list 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): CollectionOptionBuilder<T, List<T>>

Registers a callback to be executed when this collection option's values are found during parsing. The callback receives each converted value and is executed after all parsing and validation completes. For collection options, the callback is called once for each element in the collection.

provideDelegate

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

Provides the property delegate implementation for collection options. This method is called automatically by Kotlin's property delegation system. It registers the option with the Arguments instance and returns a delegate that provides access to the parsed collection value.

required

fun required(): OptionListBuilder<T>

Marks this list option as required, equivalent to atLeast(1).

requireIfAllPresent

open override fun requireIfAllPresent(vararg refs: KProperty<*>): OptionListBuilder<T>

Makes this list 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

open override fun requireIfAnyPresent(vararg refs: KProperty<*>): OptionListBuilder<T>

Makes this list 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.

validate

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

Adds multiple element validators at once.

open override fun validate(message: String, predicate: (T) -> Boolean): OptionListBuilder<T>

Adds a validator that checks each element in the list against the given predicate.

validateCollection

open override fun validateCollection(message: String, predicate: (List<T>) -> Boolean): OptionListBuilder<T>

Adds a validator that checks the entire list against the given predicate.