Package megamek.common.util.weightedMaps

Class AbstractWeightedMap<K extends Number,T>

java.lang.Object

java.util.AbstractMap<K,T>

java.util.TreeMap<K,T>

megamek.common.util.weightedMaps.AbstractWeightedMap<K,T>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,T>, NavigableMap<K,T>, SequencedMap<K,T>, SortedMap<K,T>

Direct Known Subclasses:

WeightedDoubleMap, WeightedIntMap

public abstract class AbstractWeightedMap<K extends Number,T>
extends TreeMap<K,T>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
AbstractWeightedMap()

Method Summary

Modifier and Type	Method	Description
abstract T	add(K weight, T value)
abstract T	randomItem()
protected T	randomItem(K key)
Optional<T>	randomOptionalItem()

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, merge, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, putFirst, putIfAbsent, putLast, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, getOrDefault, hashCode, isEmpty, remove

Methods inherited from interface java.util.NavigableMap

reversed

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Constructor Details

AbstractWeightedMap

public AbstractWeightedMap()

Method Details

add

@Nullable
public abstract T add(K weight,
 T value)

Parameters:

weight - the weight to put the item at

value - the value of the item

Returns:

the return value of TreeMap#Put, or null if the value is not added to the map

randomItem

@Nullable
public abstract T randomItem()

Returns:

a random item from the weighted map, or null if it is empty

randomItem

@Nullable
protected T randomItem(K key)

Parameters:

key - the key of the item to get (used for simplification and unit testing reasons)

Returns:

the item from the weighted map, or null if it does not exist

randomOptionalItem

public Optional<T> randomOptionalItem()

Returns:

a random item from the weighted map boxed in an Optional, empty if the map is empty