Argos/onl.ycode.argos/NonNullableArityOptionBuilder

NonNullableArityOptionBuilder

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

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

This class is created when calling .required() or .atLeast(n) on an ArityOptionBuilder. Returns List<T> (non-nullable) and preserves all arity functionality. Follows the same pattern as NonNullableOptionBuilder.

Parameters

The element type of the values in the returned list

Functions

atLeastOneWith

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

atMostOneWith

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

conflictsWith

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

exactlyOneWith

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

help

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

hidden

fun hidden(): NonNullableArityOptionBuilder<T>

onValue

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

Registers a callback to be executed when this required arity option receives a value. The callback receives List (non-nullable) since this is a required option.

provideDelegate

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

requireIfAllPresent

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

requireIfAnyPresent

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

requireIfValue

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

validate

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