Argos/onl.ycode.argos/AritySetOptionBuilder

AritySetOptionBuilder

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

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

This class is created when calling .arity(n) on a set option builder. Each invocation of the option consumes exactly n values to create a sublist. Returns Set<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): NonNullableAritySetOptionBuilder<T>

atLeastOneWith

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

atMostOneWith

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

conflictsWith

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

default

fun default(value: Set<List<T>>): NonNullableAritySetOptionBuilder<T>

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

exactlyOneWith

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

help

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

hidden

fun hidden(): AritySetOptionBuilder<T>

onValue

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

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

provideDelegate

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

required

fun required(): NonNullableAritySetOptionBuilder<T>

requireIfAllPresent

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

requireIfAnyPresent

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

requireIfValue

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

validate

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

validateCollection

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

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