parameterize-api/com.benwoodworth.parameterize

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class ExperimentalParameterizeApi

Marks declarations that are still experimental in Parameterize, which means that the design of the corresponding declarations has open issues which may (or may not) lead to their changes in the future. Roughly speaking, there is a chance that those declarations will be deprecated in the near future or the semantics of their behavior may change in some way that may break some code.

LazyParameterScope

@JvmInline

value class LazyParameterScope

The scope for lazy parameter {} blocks.

ParameterizeScope

interface ParameterizeScope

The scope for parameterized code blocks, exposing parameter builders and enabling them to be declared.

Functions

parameter

@JvmName(name = "parameterLazyIterable")

inline fun <T> ParameterizeScope.parameter(crossinline lazyArguments: LazyParameterScope.() -> Iterable<T>): ParameterizeScope.Parameter<T>

@JvmName(name = "parameterLazySequence")

inline fun <T> ParameterizeScope.parameter(crossinline lazyArguments: LazyParameterScope.() -> Sequence<T>): ParameterizeScope.Parameter<T>

Used to declare a parameter with the computed lazyArguments. The arguments are only computed the first time the parameter is used, and not at all if used.

fun <T> ParameterizeScope.parameter(arguments: Iterable<T>): ParameterizeScope.Parameter<T>

fun <T> ParameterizeScope.parameter(arguments: Sequence<T>): ParameterizeScope.Parameter<T>

Used to declare a parameter with the supplied arguments.

parameterOf

fun <T> ParameterizeScope.parameterOf(vararg arguments: T): ParameterizeScope.Parameter<T>

Used to declare a parameter with the listed arguments.