Argos/onl.ycode.argos/ArityOptionBuilder

ArityOptionBuilder

class ArityOptionBuilder<T> : PropertyDelegateProvider<Arguments, ReadOnlyProperty<Arguments, List<T>?>> (source)

Builder for arity-based options that return nullable lists of values.

This class is created when calling .arity(n) on an option builder and provides a fluent API for configuring multi-value options that must consume exactly n values. Returns List<T>? (nullable) - use .required() to get non-nullable List<T>.

Parameters

The element type of the values in the returned list

Functions

atLeast

fun atLeast(n: Int): NonNullableArityOptionBuilder<T>

Marks this arity option as required with a minimum number of occurrences. For arity options, atLeast(n) implies required().

atLeastOneWith

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

atMostOneWith

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

conflictsWith

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

default

fun default(value: List<T>): NonNullableArityOptionBuilder<T>

Sets a default value for this arity option, making it non-nullable. The default value should be a List with exactly arityCount elements.

exactlyOneWith

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

help

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

hidden

fun hidden(): ArityOptionBuilder<T>

onValue

fun onValue(callback: (List<T>?) -> Unit): ArityOptionBuilder<T>

Registers a callback to be executed when this arity option receives a value. The callback receives List? - null if the option was not provided, List if it was.

provideDelegate

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

required

fun required(): NonNullableArityOptionBuilder<T>

Marks this arity option as required, making it non-nullable. Returns a NonNullableArityOptionBuilder that preserves arity functionality.

requireIfAllPresent

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

requireIfAnyPresent

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

requireIfValue

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

validate

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