org.spongepowered.api.data.value.immutable

Interface ImmutableWeightedCollectionValue<E>

Type Parameters:

E - The type of weighted object

All Superinterfaces:

BaseValue<WeightedTable<E>>, ImmutableCollectionValue<TableEntry<E>,WeightedTable<E>,ImmutableWeightedCollectionValue<E>,WeightedCollectionValue<E>>, ImmutableValue<WeightedTable<E>>

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

Represents a particular type of ImmutableCollectionValue 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.immutable.ImmutableCollectionValue

asMutable, contains, containsAll, getAll, isEmpty, size, transform, with, withAll, withElement, without, withoutAll, withoutAll

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

exists, get, getDefault, getDirect, getKey

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