Module is.codion.tools.loadtest.core

Package is.codion.tools.loadtest.randomizer

Interface ItemRandomizer<T>

Type Parameters:

T - the type of item this random item model returns

public interface ItemRandomizer<T>

ItemRandomizer provides a way to randomly choose an item based on a weight value.

 Item one = new Item();
 Item two = new Item();
 Item three = new Item();

 ItemRandomizer<Object> randomizer = ItemRandomizer.randomizer(Arrays.asList(one, two, three));

 randomizer.setWeight(one, 10);
 randomizer.setWeight(two, 60);
 randomizer.setWeight(three, 30);

 //10% chance of getting 'one', 60% chance of getting 'two' and 30% chance of getting 'three'.
 Item random = randomizer.get().orElse(null);

For instances use the following factory functions: randomizer(Collection)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ItemRandomizer.RandomItem<T>	Wraps an item for usage in the ItemRandomizer.

Method Summary

Modifier and Type	Method	Description
State	enabled(T item)
Optional<T>	get()	Fetches a random item from this model based on the item weights.
Collection<ItemRandomizer.RandomItem<T>>	items()
static <T> ItemRandomizer<T>	randomizer(Collection<ItemRandomizer.RandomItem<T>> items)	Instantiates a new ItemRandomizer.
Value<Integer>	weight(T item)

Method Details

items

Collection<ItemRandomizer.RandomItem<T>> items()

Returns:

the items in this model.

weight

Value<Integer> weight(T item)

Returns:

the Value controlling the weight

enabled

State enabled(T item)

Parameters:

item - the item

Returns:

the item enabled state

get

Optional<T> get()

Fetches a random item from this model based on the item weights.

Returns:

a randomly chosen item or an empty Optional in case no item is enabled or the total weights are zero

randomizer

static <T> ItemRandomizer<T> randomizer(Collection<ItemRandomizer.RandomItem<T>> items)

Instantiates a new ItemRandomizer.

Type Parameters:

T - the item type

Parameters:

items - the items to randomize

Returns:

a new ItemRandomizer