parameterize/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.

ParameterizeConfiguration

class ParameterizeConfiguration

Configuration options for parameterize.

ParameterizeDsl

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPE, AnnotationTarget.TYPEALIAS])

annotation class ParameterizeDsl

Used to prevent parameterize functions from being used in the wrong scope.

ParameterizeFailedError

expect class ParameterizeFailedError : AssertionError

Thrown to indicate that parameterize has completed with failures.

actual class ParameterizeFailedError : AssertionError

actual class ParameterizeFailedError : MultipleFailuresError

actual class ParameterizeFailedError : AssertionError

ParameterizeFailure

class ParameterizeFailure

A failure thrown from a parameterize iteration, and the arguments that caused it.

ParameterizeScope

class ParameterizeScope

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>

Declares a parameter with the given 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>

Declare a parameter with the given arguments.

parameterize

inline fun parameterize(configuration: ParameterizeConfiguration = ParameterizeConfiguration.default, block: ParameterizeScope.() -> Unit)

Executes the block for each combination of arguments, as declared with the parameter functions:

inline fun parameterize(configuration: ParameterizeConfiguration = ParameterizeConfiguration.default, noinline decorator: suspend DecoratorScope.(iteration: suspend DecoratorScope.() -> Unit) -> Unit = configuration.decorator, noinline onFailure: OnFailureScope.(failure: Throwable) -> Unit = configuration.onFailure, noinline onComplete: OnCompleteScope.() -> Unit = configuration.onComplete, block: ParameterizeScope.() -> Unit)

Calls parameterize with a copy of the configuration that has options overridden.

parameterOf

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

Declare a parameter with the given arguments.