org.spongepowered.api.util.weighted

Class WeightedTable<T>

java.lang.Object

org.spongepowered.api.util.weighted.RandomObjectTable<T>

org.spongepowered.api.util.weighted.WeightedTable<T>

Type Parameters:

T - The entry type

All Implemented Interfaces:

Iterable<TableEntry<T>>, Collection<TableEntry<T>>

Direct Known Subclasses:

UnmodifiableWeightedTable

public class WeightedTable<T>
extends RandomObjectTable<T>

A table of weighted entry, each entry is given a weight, the higher the weight the more likely the chance that the entry is chosen. Each roll will only return a single entries value.

Field Summary

Fields inherited from class org.spongepowered.api.util.weighted.RandomObjectTable

entries

Constructor Summary

Constructors

Constructor and Description
WeightedTable() Creates a new WeightedTable with a default roll count of 1.
WeightedTable(int rolls) Creates a new WeightedTable with the provided number of rolls.
WeightedTable(VariableAmount rolls) Creates a new WeightedTable with the provided VariableAmount for the amount of rolls and variance.

Method Summary

Modifier and Type	Method and Description
boolean	add(TableEntry<T> entry)
boolean	add(T object, double weight) Adds the given object to the table with the given weight.
boolean	addAll(Collection<? extends TableEntry<T>> c)
void	clear()
boolean	equals(Object o)
List<T>	get(Random rand) Performs a number of rolls according to the number of rolls defined by RandomObjectTable.getRolls() and returns items from the table for each roll.
int	hashCode()
Iterator<TableEntry<T>>	iterator()
protected void	recalculateWeight() Recalculates the total weight of all entries in this table.
boolean	remove(Object entry)
boolean	removeAll(Collection<?> c)
boolean	removeObject(Object entry) Removes the first instance of an entry in this table which is a WeightedObject entry and contains the given object.
boolean	retainAll(Collection<?> c)
String	toString()

Methods inherited from class org.spongepowered.api.util.weighted.RandomObjectTable

contains, containsAll, containsAllObjects, containsObject, getEntries, getRolls, isEmpty, setRolls, setRolls, size, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

WeightedTable

public WeightedTable()

Creates a new WeightedTable with a default roll count of 1.

WeightedTable

public WeightedTable(int rolls)

Creates a new WeightedTable with the provided number of rolls.

Parameters:

rolls - The rolls for variance

WeightedTable

public WeightedTable(VariableAmount rolls)

Creates a new WeightedTable with the provided VariableAmount for the amount of rolls and variance.

Parameters:

rolls - The rolls for variance

Method Detail

add

public boolean add(TableEntry<T> entry)

Specified by:

add in interface Collection<TableEntry<T>>

Overrides:

add in class RandomObjectTable<T>

add

public boolean add(T object,
                   double weight)

Description copied from class: RandomObjectTable

Adds the given object to the table with the given weight.

Overrides:

add in class RandomObjectTable<T>

Parameters:

object - The new object

weight - The weight of the object

Returns:

If the object was successfully added

addAll

public boolean addAll(Collection<? extends TableEntry<T>> c)

Specified by:

addAll in interface Collection<TableEntry<T>>

Overrides:

addAll in class RandomObjectTable<T>

remove

public boolean remove(Object entry)

Specified by:

remove in interface Collection<TableEntry<T>>

Overrides:

remove in class RandomObjectTable<T>

removeObject

public boolean removeObject(Object entry)

Description copied from class: RandomObjectTable

Removes the first instance of an entry in this table which is a WeightedObject entry and contains the given object.

Overrides:

removeObject in class RandomObjectTable<T>

Parameters:

entry - The object to remove

Returns:

If the table was changed as a result

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<TableEntry<T>>

Overrides:

removeAll in class RandomObjectTable<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<TableEntry<T>>

Overrides:

retainAll in class RandomObjectTable<T>

clear

public void clear()

Specified by:

clear in interface Collection<TableEntry<T>>

Overrides:

clear in class RandomObjectTable<T>

recalculateWeight

protected void recalculateWeight()

Recalculates the total weight of all entries in this table.

get

public List<T> get(Random rand)

Description copied from class: RandomObjectTable

Performs a number of rolls according to the number of rolls defined by RandomObjectTable.getRolls() and returns items from the table for each roll.

Specified by:

get in class RandomObjectTable<T>

Parameters:

rand - The random object to use

Returns:

The returned items, may be empty but not null

iterator

public Iterator<TableEntry<T>> iterator()

Specified by:

iterator in interface Iterable<TableEntry<T>>

Specified by:

iterator in interface Collection<TableEntry<T>>

Overrides:

iterator in class RandomObjectTable<T>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<TableEntry<T>>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<TableEntry<T>>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object