Package net.solarnetwork.util

Class IntShortMap

java.lang.Object

java.util.AbstractMap<Integer,Short>

net.solarnetwork.util.IntShortMap

All Implemented Interfaces:

Cloneable, Map<Integer,Short>, IntShortOrderedIterable

public class IntShortMap
extends AbstractMap<Integer,Short>
implements Map<Integer,Short>, IntShortOrderedIterable, Cloneable

A map implementation optimized for sparse array like storage of integer keys with associated short values.

This implementation is optimized for small sizes and appending keys in ascending order. Random mutations trigger array copies that can slow performance down considerably. Accessing values run in O(log n) time. Keys are maintained in ascending order, so iteration occurs also in ascending order.

Since:

1.58

Version:

1.0

Author:

matt

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>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_INITIAL_CAPACITY	The default initial capacity.
static final short	VALUE_NO_SUCH_ELEMENT	The default value that causes NoSuchElementException to be thrown in getValue(int).

Constructor Summary

Constructors

Constructor	Description
IntShortMap()	Default constructor.
IntShortMap(int initialCapacity)	Constructor.
IntShortMap(int initialCapacity, short notFoundValue)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()
Object	clone()
boolean	compact()	Free up excess capacity.
boolean	containsKey(int k)	Test if a primitive key value exists in this map.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<Integer,Short>>	entrySet()
void	forEachOrdered(int min, int max, IntShortBiConsumer action)	Iterate over a range of key/value pairs in this map.
void	forEachOrdered(IntShortBiConsumer action)	Iterate over all key/value pairs in this map.
Short	get(int k)	Get the value for a given key.
Short	get(Object key)
int	getCapacity()	Get the current capacity.
short	getValue(int k)	Get the value for a given key.
Set<Integer>	keySet()
Short	put(Integer key, Short value)
Short	putValue(int k, int value)	Get primitive values.
Short	putValue(int k, short value)	Put primitive values.
int	size()
String	toString()
Map<Integer,Integer>	unsignedMap()	Get a view of this map with unsigned integer values.
Collection<Short>	values()

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, putAll, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Field Details

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The default initial capacity.

See Also:

• Constant Field Values

VALUE_NO_SUCH_ELEMENT

public static final short VALUE_NO_SUCH_ELEMENT

The default value that causes NoSuchElementException to be thrown in getValue(int).

See Also:

• Constant Field Values

Constructor Details

IntShortMap

public IntShortMap()

Default constructor.

Defaults to returning 0 for nonexistent keys in getValue(int).

IntShortMap

public IntShortMap(int initialCapacity)

Constructor.

Defaults to returning 0 for nonexistent keys in getValue(int).

Parameters:

initialCapacity - the initial capacity

Throws:

IllegalArgumentException - if initialCapacity is less than 1

IntShortMap

public IntShortMap(int initialCapacity,
 short notFoundValue)

Constructor.

Parameters:

initialCapacity - the initial capacity

notFoundValue - the value to return in getValue(int) if a key is not found, or VALUE_NO_SUCH_ELEMENT to throw a NoSuchElementException

Throws:

IllegalArgumentException - if initialCapacity is less than 1

Method Details

toString

public String toString()

Overrides:

toString in class AbstractMap<Integer,Short>

clone

public Object clone()

Overrides:

clone in class AbstractMap<Integer,Short>

entrySet

public Set<Map.Entry<Integer,Short>> entrySet()

Specified by:

entrySet in interface Map<Integer,Short>

Specified by:

entrySet in class AbstractMap<Integer,Short>

size

public int size()

Specified by:

size in interface Map<Integer,Short>

Overrides:

size in class AbstractMap<Integer,Short>

forEachOrdered

public void forEachOrdered(IntShortBiConsumer action)

Iterate over all key/value pairs in this map.

This method of iteration can be more efficient than iterating via entrySet() because no intermediate Set, Iterator, or Entry objects are created, and not primitive boxing occurs.

Specified by:

forEachOrdered in interface IntShortOrderedIterable

Parameters:

action - the consumer to handle the key/value pairs

forEachOrdered

public void forEachOrdered(int min,
 int max,
 IntShortBiConsumer action)

Iterate over a range of key/value pairs in this map.

This method of iteration can be more efficient than iterating via entrySet() because no intermediate Set, Iterator, or Entry objects are created, and not primitive boxing occurs.

Specified by:

forEachOrdered in interface IntShortOrderedIterable

Parameters:

min - the minimum key value (inclusive)

max - the maximum key value (exclusive)

action - the consumer to handle the key/value pairs

keySet

public Set<Integer> keySet()

Specified by:

keySet in interface Map<Integer,Short>

Overrides:

keySet in class AbstractMap<Integer,Short>

values

public Collection<Short> values()

Specified by:

values in interface Map<Integer,Short>

Overrides:

values in class AbstractMap<Integer,Short>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Integer,Short>

Overrides:

containsValue in class AbstractMap<Integer,Short>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Integer,Short>

Overrides:

containsKey in class AbstractMap<Integer,Short>

containsKey

public boolean containsKey(int k)

Test if a primitive key value exists in this map.

Parameters:

k - the key to test

Returns:

true if the key exists in this map

clear

public void clear()

Specified by:

clear in interface Map<Integer,Short>

Overrides:

clear in class AbstractMap<Integer,Short>

getCapacity

public int getCapacity()

Get the current capacity.

Returns:

the capacity

compact

public boolean compact()

Free up excess capacity.

Returns:

true if any capacity was freed

get

public Short get(Object key)

Specified by:

get in interface Map<Integer,Short>

Overrides:

get in class AbstractMap<Integer,Short>

get

public Short get(int k)

Get the value for a given key.

Parameters:

k - the key of the value to get

Returns:

the associated value, or null if k is not present

getValue

public short getValue(int k)

Get the value for a given key.

Parameters:

k - the key of the value to get

Returns:

the associated value

Throws:

NoSuchElementException - if k is not present

putValue

public Short putValue(int k,
 int value)

Get primitive values.

Parameters:

k - the key

value - the value, which will be down-cast to a short

Returns:

the previous value associated with k, or null if none

putValue

public Short putValue(int k,
 short value)

Put primitive values.

Parameters:

k - the key

value - the value

Returns:

the previous value associated with k, or null if none

put

public Short put(Integer key,
 Short value)

Specified by:

put in interface Map<Integer,Short>

Overrides:

put in class AbstractMap<Integer,Short>

unsignedMap

public Map<Integer,Integer> unsignedMap()

Get a view of this map with unsigned integer values.

Returns:

a new map, backed by this map's data, where the values are returned as unsigned integers