org.spongepowered.api.util.weighted

Class RandomObjectTable<T>

java.lang.Object

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

Type Parameters:

T - The type of entry

All Implemented Interfaces:

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

Direct Known Subclasses:

ChanceTable, WeightedTable

public abstract class RandomObjectTable<T>
extends Object
implements Collection<TableEntry<T>>

An abstract table holding weighted objects. Objects may be retrieved from the table according to weight or chance.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TableEntry<T>>	entries

Constructor Summary

Constructors

Constructor and Description
RandomObjectTable(int rolls) Creates a new RandomObjectTable with the provided number of rolls.
RandomObjectTable(VariableAmount rolls) Creates a new RandomObjectTable with the provided number of rolls.

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	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	containsAllObjects(Collection<?> c) Gets if this table contains all of the given objects, the objects may either be TableEntrys or the objects contained within the entries.
boolean	containsObject(Object obj) Gets if this table contains the given object, the object may either be a TableEntry or the object contained within.
abstract List<T>	get(Random rand) Performs a number of rolls according to the number of rolls defined by getRolls() and returns items from the table for each roll.
List<TableEntry<T>>	getEntries() Gets the entries in the table.
VariableAmount	getRolls() Gets the number of times this table will roll while retrieving items.
boolean	isEmpty()
Iterator<TableEntry<T>>	iterator()
boolean	remove(Object entry)
boolean	removeAll(Collection<?> c)
boolean	removeObject(Object object) Removes the first instance of an entry in this table which is a WeightedObject entry and contains the given object.
boolean	retainAll(Collection<?> c)
void	setRolls(int rolls) Sets the number of times this table will roll while retrieving items.
void	setRolls(VariableAmount rolls) Sets the number of times this table will roll while retrieving items.
int	size()
Object[]	toArray()
<R> R[]	toArray(R[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

entries

protected final List<TableEntry<T>> entries

Constructor Detail

RandomObjectTable

public RandomObjectTable(int rolls)

Creates a new RandomObjectTable with the provided number of rolls.

Parameters:

rolls - the rolls

See Also:

getRolls()

RandomObjectTable

public RandomObjectTable(VariableAmount rolls)

Creates a new RandomObjectTable with the provided number of rolls.

Parameters:

rolls - the rolls

See Also:

getRolls()

Method Detail

getRolls

public VariableAmount getRolls()

Gets the number of times this table will roll while retrieving items. For each roll a complete pass through of the table will occur.

Returns:

The number of rolls

setRolls

public void setRolls(VariableAmount rolls)

Sets the number of times this table will roll while retrieving items.

Parameters:

rolls - The new roll count

setRolls

public void setRolls(int rolls)

Sets the number of times this table will roll while retrieving items.

Parameters:

rolls - The new roll count

add

public boolean add(TableEntry<T> entry)

Specified by:

add in interface Collection<TableEntry<T>>

add

public boolean add(T object,
                   double weight)

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

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>>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<TableEntry<T>>

containsObject

public boolean containsObject(Object obj)

Gets if this table contains the given object, the object may either be a TableEntry or the object contained within.

Parameters:

obj - The object to check for

Returns:

If the object is contained within the table

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<TableEntry<T>>

containsAllObjects

public boolean containsAllObjects(Collection<?> c)

Gets if this table contains all of the given objects, the objects may either be TableEntrys or the objects contained within the entries.

Parameters:

c - The objects to check for

Returns:

If all of the objects are contained within the table

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<TableEntry<T>>

remove

public boolean remove(Object entry)

Specified by:

remove in interface Collection<TableEntry<T>>

removeObject

public boolean removeObject(Object object)

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

Parameters:

object - 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>>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<TableEntry<T>>

clear

public void clear()

Specified by:

clear in interface Collection<TableEntry<T>>

size

public int size()

Specified by:

size in interface Collection<TableEntry<T>>

get

public abstract List<T> get(Random rand)

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

Parameters:

rand - The random object to use

Returns:

The returned items, may be empty but not null

getEntries

public List<TableEntry<T>> getEntries()

Gets the entries in the table. Note that the specific sub class of this abstract table will determine the context that the entry weights should be interpreted in (either weights or chances).

Returns:

The raw entries

iterator

public Iterator<TableEntry<T>> iterator()

Specified by:

iterator in interface Iterable<TableEntry<T>>

Specified by:

iterator in interface Collection<TableEntry<T>>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<TableEntry<T>>

toArray

public <R> R[] toArray(R[] a)

Specified by:

toArray in interface Collection<TableEntry<T>>