Package org.instancio

Interface CartesianProductApi<T>

Type Parameters:

T - type to create

@ExperimentalApi
public interface CartesianProductApi<T>

Provides an API for generating the Cartesian product.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
CartesianProductApi<T>	assign(Assignment... assignments)
<V> CartesianProductApi<T>	generate(TargetSelector selector, GeneratorSpec<V> spec)
<V> CartesianProductApi<T>	generate(TargetSelector selector, GeneratorSpecProvider<V> gen)
CartesianProductApi<T>	ignore(TargetSelector selector)
CartesianProductApi<T>	lenient()
List<T>	list()	Returns he Cartesian product generated from values specified via the with(TargetSelector, Object[]) method as a list.
<V> CartesianProductApi<T>	onComplete(TargetSelector selector, OnCompleteCallback<V> callback)
<V> CartesianProductApi<T>	set(TargetSelector selector, V value)
CartesianProductApi<T>	subtype(TargetSelector selector, Class<?> subtype)
<V> CartesianProductApi<T>	supply(TargetSelector selector, Supplier<V> supplier)
<V> CartesianProductApi<T>	supply(TargetSelector selector, Generator<V> generator)
CartesianProductApi<T>	verbose()
<V> CartesianProductApi<T>	with(TargetSelector selector, V... values)	Sets a range of values for generating the Cartesian product.
CartesianProductApi<T>	withMaxDepth(int maxDepth)
CartesianProductApi<T>	withNullable(TargetSelector selector)
CartesianProductApi<T>	withSeed(long seed)
CartesianProductApi<T>	withSettings(Settings settings)

Method Details

with

@ExperimentalApi
<V> CartesianProductApi<T> with(TargetSelector selector,
 V... values)

Sets a range of values for generating the Cartesian product. The results are returned as a list in lexicographical order using the list() method.

Example:

 record Widget(String type, int num) {}

 List<Widget> results = Instancio.ofCartesianProduct(Widget.class)
     .with(field(Widget::type), "FOO", "BAR", "BAZ")
     .with(field(Widget::num), 1, 2, 3)
     .list();
 

This will produce the following list of Widget objects:

 [Widget[type=FOO, num=1],
  Widget[type=FOO, num=2],
  Widget[type=FOO, num=3],
  Widget[type=BAR, num=1],
  Widget[type=BAR, num=2],
  Widget[type=BAR, num=3],
  Widget[type=BAZ, num=1],
  Widget[type=BAZ, num=2],
  Widget[type=BAZ, num=3]]
 

Limitations

A selector passed to with() must match a single target. For example, Cartesian product cannot be generated for collection elements:

 record Widget(String type, int num) {}
 record Container(List<Widget> widgets) {}

 List<Container> results = Instancio.ofCartesianProduct(Container.class)
     .with(field(Widget::type), "FOO", "BAR", "BAZ")
     .with(field(Widget::num), 1, 2, 3)
     .list();
 

The above will produce an error with a message: "no item is available to emit()".

Type Parameters:

V - type of the value

Parameters:

selector - for fields and/or classes this method should be applied to

values - the range of values to generate

Returns:

API builder reference

Since:

4.0.0

list

@ExperimentalApi
List<T> list()

Returns he Cartesian product generated from values specified via the with(TargetSelector, Object[]) method as a list.

Returns:

Cartesian product as a list

Since:

4.0.0

ignore

CartesianProductApi<T> ignore(TargetSelector selector)

Since:

4.0.0

withNullable

CartesianProductApi<T> withNullable(TargetSelector selector)

Since:

4.0.0

set

<V> CartesianProductApi<T> set(TargetSelector selector,
 V value)

Since:

4.0.0

supply

<V> CartesianProductApi<T> supply(TargetSelector selector,
 Supplier<V> supplier)

Since:

4.0.0

supply

<V> CartesianProductApi<T> supply(TargetSelector selector,
 Generator<V> generator)

Since:

4.0.0

generate

<V> CartesianProductApi<T> generate(TargetSelector selector,
 GeneratorSpecProvider<V> gen)

Since:

4.0.0

generate

@ExperimentalApi
<V> CartesianProductApi<T> generate(TargetSelector selector,
 GeneratorSpec<V> spec)

Since:

4.0.0

onComplete

<V> CartesianProductApi<T> onComplete(TargetSelector selector,
 OnCompleteCallback<V> callback)

Since:

4.0.0

subtype

CartesianProductApi<T> subtype(TargetSelector selector,
 Class<?> subtype)

Since:

4.0.0

assign

@ExperimentalApi
CartesianProductApi<T> assign(Assignment... assignments)

Since:

4.0.0

withMaxDepth

CartesianProductApi<T> withMaxDepth(int maxDepth)

Since:

4.0.0

withSettings

CartesianProductApi<T> withSettings(Settings settings)

Since:

4.0.0

withSeed

CartesianProductApi<T> withSeed(long seed)

Since:

4.0.0

lenient

CartesianProductApi<T> lenient()

Since:

4.0.0

verbose

CartesianProductApi<T> verbose()

Since:

4.0.0