org.spongepowered.api.data.value.mutable

Interface WeightedCollectionValue<E>

Type Parameters:

E - The type of weighted object

All Superinterfaces:

BaseValue<WeightedTable<E>>, CollectionValue<TableEntry<E>,WeightedTable<E>,WeightedCollectionValue<E>,ImmutableWeightedCollectionValue<E>>, Iterable<TableEntry<E>>, Value<WeightedTable<E>>

public interface WeightedCollectionValue<E>
extends CollectionValue<TableEntry<E>,WeightedTable<E>,WeightedCollectionValue<E>,ImmutableWeightedCollectionValue<E>>

Represents a particular type of CollectionValue that is backed by a WeightedTable.

Method Summary

Modifier and Type	Method and Description
List<E>	get(Random random) Selects a random value from this list based on their weight.

Methods inherited from interface org.spongepowered.api.data.value.mutable.CollectionValue

add, addAll, asImmutable, contains, containsAll, copy, filter, getAll, isEmpty, remove, removeAll, removeAll, set, size, transform

Methods inherited from interface org.spongepowered.api.data.value.BaseValue

exists, get, getDefault, getDirect, getKey

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

@Nullable
List<E> get(Random random)

Selects a random value from this list based on their weight.

If the list is empty then null will be returned.

Parameters:

random - The random object to use for selection

Returns:

The selected value