Argos/onl.ycode.argos/ArityListOptionBuilder

ArityListOptionBuilder

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

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

This class is created when calling .arity(n) on a list option builder. Each invocation of the option consumes exactly n values to create a sublist. Returns List<List<T>>? (nullable) - use .required() to get non-nullable.

Parameters

The element type of the values in the sublists

Functions

atLeast

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

atLeastOneWith

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

atMostOneWith

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

conflictsWith

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

default

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

Sets a default value for this list arity option, making it non-nullable. The default value should be a List> where each sublist has exactly arityCount elements.

exactlyOneWith

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

help

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

hidden

fun hidden(): ArityListOptionBuilder<T>

onValue

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

Registers a callback to be invoked when this list arity option receives values. The callback receives the complete List>? value.

provideDelegate

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

required

fun required(): NonNullableArityListOptionBuilder<T>

requireIfAllPresent

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

requireIfAnyPresent

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

requireIfValue

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

validate

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

validateCollection

fun validateCollection(message: String = "Invalid collection for @name: @value", predicate: (List<List<T>>?) -> Boolean): ArityListOptionBuilder<T>

Validates the entire collection of arity groups for this list option. The predicate receives the complete List>? value.