UnmodifiableWeightedTable (SpongeAPI 7.3.0 API)

java.lang.Object
- org.spongepowered.api.util.weighted.RandomObjectTable<T>
- - org.spongepowered.api.util.weighted.WeightedTable<T>
  - - org.spongepowered.api.util.weighted.UnmodifiableWeightedTable<T>

Type Parameters:

T - Item type

All Implemented Interfaces:

Iterable<TableEntry<T>>, Collection<TableEntry<T>>
```
public class UnmodifiableWeightedTable<T>
extends WeightedTable<T>
```
Creates a WeightedTable that is completely immutable, but still is able to be changed via its proxy table.

Field Summary
- Fields inherited from class org.spongepowered.api.util.weighted.RandomObjectTable
  entries

Constructor Summary

Constructors
Constructor and Description
`UnmodifiableWeightedTable(WeightedTable<T> table)` Creates a new `UnmodifiableWeightedTable` with the provided `WeightedTable`.
`UnmodifiableWeightedTable(WeightedTable<T> table, int rolls)` Creates a new `UnmodifiableWeightedTable` with the provided `WeightedTable` and `rolls`.
`UnmodifiableWeightedTable(WeightedTable<T> table, VariableAmount rolls)` Creates a new `UnmodifiableWeightedTable` with the provided `WeightedTable` and `rolls`.

Method Summary

All Methods Instance Methods Concrete Methods
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 `TableEntry`s 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.
`boolean`	`equals(Object o)`
`void`	`forEach(Consumer<? super TableEntry<T>> action)`
`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.
`List<TableEntry<T>>`	`getEntries()` Gets the entries in the table.
`VariableAmount`	`getRolls()` Gets the number of times this table will roll while retrieving items.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<TableEntry<T>>`	`iterator()`
`Stream<TableEntry<T>>`	`parallelStream()`
`boolean`	`remove(Object entry)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`removeIf(Predicate<? super TableEntry<T>> filter)`
`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)`
`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()`
`Spliterator<TableEntry<T>>`	`spliterator()`
`Stream<TableEntry<T>>`	`stream()`
`Object[]`	`toArray()`
`<R> R[]`	`toArray(R[] a)`
`String`	`toString()`

Methods inherited from class org.spongepowered.api.util.weighted.WeightedTable
recalculateWeight

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UnmodifiableWeightedTable
```
public UnmodifiableWeightedTable(WeightedTable<T> table)
```
    Creates a new UnmodifiableWeightedTable with the provided WeightedTable.
    
    Parameters:
    
    table - The table to provide
  - UnmodifiableWeightedTable
```
public UnmodifiableWeightedTable(WeightedTable<T> table,
                                 int rolls)
```
    Creates a new UnmodifiableWeightedTable with the provided WeightedTable and rolls.
    
    Parameters:
    
    table - The table
    
    rolls - The rolls
  - UnmodifiableWeightedTable
```
public UnmodifiableWeightedTable(WeightedTable<T> table,
                                 VariableAmount rolls)
```
    Creates a new UnmodifiableWeightedTable with the provided WeightedTable and rolls.
    
    Parameters:
    
    table - The table
    
    rolls - The rolls
- Method Detail
  - add
```
public boolean add(TableEntry<T> entry)
```
    Specified by:
    
    add in interface Collection<TableEntry<T>>
    
    Overrides:
    
    add in class WeightedTable<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 WeightedTable<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 WeightedTable<T>
  - setRolls
```
public void setRolls(VariableAmount rolls)
```
    Description copied from class: RandomObjectTable
    
    Sets the number of times this table will roll while retrieving items.
    
    Overrides:
    
    setRolls in class RandomObjectTable<T>
    
    Parameters:
    
    rolls - The new roll count
  - setRolls
```
public void setRolls(int rolls)
```
    Description copied from class: RandomObjectTable
    
    Sets the number of times this table will roll while retrieving items.
    
    Overrides:
    
    setRolls in class RandomObjectTable<T>
    
    Parameters:
    
    rolls - The new roll count
  - remove
```
public boolean remove(Object entry)
```
    Specified by:
    
    remove in interface Collection<TableEntry<T>>
    
    Overrides:
    
    remove in class WeightedTable<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 WeightedTable<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 WeightedTable<T>
  - removeIf
```
public boolean removeIf(Predicate<? super TableEntry<T>> filter)
```
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<TableEntry<T>>
    
    Overrides:
    
    retainAll in class WeightedTable<T>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<TableEntry<T>>
    
    Overrides:
    
    clear in class WeightedTable<T>
  - 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 WeightedTable<T>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<TableEntry<T>>
    
    Overrides:
    
    contains in class RandomObjectTable<T>
  - getRolls
```
public VariableAmount getRolls()
```
    Description copied from class: RandomObjectTable
    
    Gets the number of times this table will roll while retrieving items. For each roll a complete pass through of the table will occur.
    
    Overrides:
    
    getRolls in class RandomObjectTable<T>
    
    Returns:
    
    The number of rolls
  - 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.
    
    Overrides:
    
    get in class WeightedTable<T>
    
    Parameters:
    
    rand - The random object to use
    
    Returns:
    
    The returned items, may be empty but not null
  - containsObject
```
public boolean containsObject(Object obj)
```
    Description copied from class: RandomObjectTable
    
    Gets if this table contains the given object, the object may either be a TableEntry or the object contained within.
    
    Overrides:
    
    containsObject in class RandomObjectTable<T>
    
    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>>
    
    Overrides:
    
    containsAll in class RandomObjectTable<T>
  - containsAllObjects
```
public boolean containsAllObjects(Collection<?> c)
```
    Description copied from class: RandomObjectTable
    
    Gets if this table contains all of the given objects, the objects may either be TableEntrys or the objects contained within the entries.
    
    Overrides:
    
    containsAllObjects in class RandomObjectTable<T>
    
    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>>
    
    Overrides:
    
    isEmpty in class RandomObjectTable<T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<TableEntry<T>>
    
    Overrides:
    
    size in class RandomObjectTable<T>
  - getEntries
```
public List<TableEntry<T>> getEntries()
```
    Description copied from class: RandomObjectTable
    
    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).
    
    Overrides:
    
    getEntries in class RandomObjectTable<T>
    
    Returns:
    
    The raw entries
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<TableEntry<T>>
    
    Overrides:
    
    toArray in class RandomObjectTable<T>
  - toArray
```
public <R> R[] toArray(R[] a)
```
    Specified by:
    
    toArray in interface Collection<TableEntry<T>>
    
    Overrides:
    
    toArray in class RandomObjectTable<T>
  - spliterator
```
public Spliterator<TableEntry<T>> spliterator()
```
  - stream
```
public Stream<TableEntry<T>> stream()
```
  - parallelStream
```
public Stream<TableEntry<T>> parallelStream()
```
  - forEach
```
public void forEach(Consumer<? super TableEntry<T>> action)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class WeightedTable<T>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<TableEntry<T>>
    
    Overrides:
    
    hashCode in class WeightedTable<T>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<TableEntry<T>>
    
    Overrides:
    
    equals in class WeightedTable<T>

Class UnmodifiableWeightedTable<T>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

UnmodifiableWeightedTable

UnmodifiableWeightedTable

UnmodifiableWeightedTable

Method Detail

add

add

addAll

setRolls

setRolls

remove

removeObject

removeAll

removeIf

retainAll

clear

iterator

contains

getRolls

get

containsObject

containsAll

containsAllObjects

isEmpty

size

getEntries

toArray

toArray

spliterator

stream

parallelStream

forEach

toString

hashCode

equals