fiktion-core/dev.s7a.fiktion/FakeSpec

FakeSpec

class FakeSpec<Root>

Per-call configuration for generating a Root value.

Constructors

FakeSpec

constructor()

Properties

element

val <Element, CollectionType : Collection<Element>> FakeSpec<CollectionType>.element: RuleTarget<Element>

Targets elements generated for the current collection root.

key

val <Key, Value, MapType : Map<Key, Value>> FakeSpec<MapType>.key: RuleTarget<Key>

Targets keys generated for the current map root.

value

val <Key, Value, MapType : Map<Key, Value>> FakeSpec<MapType>.value: RuleTarget<Value>

Targets values generated for the current map root.

Functions

generates

infix fun <Value> PropertyPath<Root, Value>.generates(value: Value): GenerationSpec<Value>

Generates value for this nested property path.

infix fun <Value> PropertyPath<Root, Value>.generates(auto: Auto): GenerationSpec<Value>

Generates this nested property path using Fiktion's automatic generation.

infix fun <Value> PropertyPath<Root, Value>.generates(default: Default): GenerationSpec<Value>

Generates this nested property path using its constructor default value.

infix inline fun <Value> KProperty1<Root, Value>.generates(value: Value): GenerationSpec<Value>

Generates value for this property.

infix inline fun <Value> KProperty1<Root, Value>.generates(auto: Auto): GenerationSpec<Value>

Generates this property using Fiktion's automatic generation.

infix inline fun <Value> KProperty1<Root, Value>.generates(default: Default): GenerationSpec<Value>

Generates this property using its constructor default value.

generatesBy

infix fun <Value> PropertyPath<Root, Value>.generatesBy(generator: Generator<Value>): GenerationSpec<Value>

Generates this nested property path by invoking generator.

infix inline fun <Value> KProperty1<Root, Value>.generatesBy(noinline generator: Generator<Value>): GenerationSpec<Value>

Generates this property by invoking generator.

invoke

operator fun <Value> PropertyPath<Root, Value>.invoke(configure: FakeSpec<Value>.() -> Unit): GenerationSpec<Value>

Applies nested per-call configuration to this property path.

inline operator fun <Value> KProperty1<Root, Value>.invoke(noinline configure: FakeSpec<Value>.() -> Unit): GenerationSpec<Value>

operator fun <Value> KProperty1<Root, Value>.~~invoke~~(configure: FakeSpec<Value>.() -> Unit, value: KType): GenerationSpec<Value>

Applies nested per-call configuration to this property.

name

fun name(name: String): RuleNameTarget

Targets properties generated while building Root whose name is name, inferring the value type from the generator.

fun name(regex: Regex): RuleNameTarget

Targets properties generated while building Root whose name matches regex, inferring the value type from the generator.

inline fun <Value> name(name: String, typed: Unit = Unit): RuleTarget<Value>

Targets properties generated while building the current root whose value type is Value and name is name.

fun ~~name~~(name: String, value: KType): RuleTarget<*>

Targets properties generated while building Root whose value type is value and name is name.

inline fun <Value> name(regex: Regex, typed: Unit = Unit): RuleTarget<Value>

Targets properties generated while building the current root whose value type is Value and name matches regex.

fun ~~name~~(regex: Regex, value: KType): RuleTarget<*>

Targets properties generated while building Root whose value type is value and name matches regex.

property

fun <Value> property(path: PropertyPath<Root, Value>): RuleTarget<Value>

Targets a nested path starting from Root.

inline fun <Value> property(property: KProperty1<Root, Value>): RuleTarget<Value>

fun <Value> ~~property~~(property: KProperty1<Root, Value>, value: KType): RuleTarget<Value>

Targets property on Root.

fun <Value> property(path: PropertyPath<Root, Value>, configure: RuleTarget<Value>.() -> Unit): RuleTarget<Value>

Groups declarations for a nested path starting from Root.

inline fun <Value> property(property: KProperty1<Root, Value>, noinline configure: RuleTarget<Value>.() -> Unit): RuleTarget<Value>

Groups declarations for property on Root.

using

infix fun <Value : Any> using(value: FiktionConfigSetting<in Root, Value>)

fun <Value : Any> using(key: FiktionConfig<in Root, Value>, value: Value)

Configures the root value generated by this call.

infix inline fun <Value, ConfigValue : Any> KProperty1<Root, Value>.using(value: FiktionConfigSetting<in Value, ConfigValue>)

inline fun <Value, ConfigValue : Any> KProperty1<Root, Value>.using(key: FiktionConfig<in Value, ConfigValue>, value: ConfigValue)

Configures built-in or add-on generator behavior for this property.

withSeed

infix fun withSeed(seed: Long)

Sets the seed for this generation call.