Package com.blackrook.rookscript.struct

Class CountMap<T>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<T,Integer>

com.blackrook.rookscript.struct.CountMap<T>

Type Parameters:

T - the type to count.

All Implemented Interfaces:

Serializable, Cloneable, Map<T,Integer>

public class CountMap<T>
extends HashMap<T,Integer>

A special HashMap that increments or decrements a value.

Author:

Matthew Tropiano

See Also:

• Serialized Form

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
CountMap()	Creates a new map with default capacity and load factor.
CountMap(int initialCapacity)	Creates a new map with specific capacity and default load factor.
CountMap(int initialCapacity, float loadFactor)	Creates a new map with specific capacity and load factor.

Method Summary

Modifier and Type	Method	Description
int	amount(T key)	Gets the current value corresponding to the key.
int	give(T key, int amount)	Adds to a key's value.
int	take(T key, int amount)	Subtracts from a key's value.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

CountMap

public CountMap()

Creates a new map with default capacity and load factor.

CountMap

public CountMap(int initialCapacity)

Creates a new map with specific capacity and default load factor.

Parameters:

initialCapacity - initial table capacity.

CountMap

public CountMap(int initialCapacity,
 float loadFactor)

Creates a new map with specific capacity and load factor.

Parameters:

initialCapacity - initial table capacity.

loadFactor - load factor before re-hash.

Method Details

amount

public int amount(T key)

Gets the current value corresponding to the key. If the key does not exist, this returns 0.

Parameters:

key - the key.

Returns:

the current total for the key.

give

public int give(T key,
 int amount)

Adds to a key's value. If the value becomes 0, it is removed.

Parameters:

key - the key.

amount - the amount to add. If negative, calls take(key, -amount).

Returns:

the new total for the key.

take

public int take(T key,
 int amount)

Subtracts from a key's value. You can't remove more than the value (it will be set to 0). If the value becomes 0, it is removed.

Parameters:

key - the key.

amount - the amount to remove. If negative, calls give(key, -amount).

Returns:

the new total for the key.