it.unimi.dsi.fastutil.objects
Class Object2ObjectArrayMap<K,V>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2ObjectFunction<K,V>
      it.unimi.dsi.fastutil.objects.AbstractObject2ObjectMap<K,V>
          it.unimi.dsi.fastutil.objects.Object2ObjectArrayMap<K,V>

All Implemented Interfaces:

Function<K,V>, Object2ObjectFunction<K,V>, Object2ObjectMap<K,V>, Serializable, Cloneable, Map<K,V>

public class Object2ObjectArrayMap<K,V>
extends AbstractObject2ObjectMap<K,V>
implements Serializable, Cloneable

A simple, brute-force implementation of a map based on two parallel backing arrays.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of pairs: just put them into two parallel arrays and scan linearly to find an item.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ObjectMap

AbstractObject2ObjectMap.BasicEntry<K,V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ObjectMap

Object2ObjectMap.Entry<K,V>, Object2ObjectMap.FastEntrySet<K,V>

Constructor Summary

Object2ObjectArrayMap()
Creates a new empty array map.

Object2ObjectArrayMap(int capacity)
Creates a new empty array map of given capacity.

Object2ObjectArrayMap(Object[] key, Object[] value)
Creates a new empty array map with given key and value backing arrays.

Object2ObjectArrayMap(Object[] key, Object[] value, int size)
Creates a new array map with given key and value backing arrays, using the given number of elements.

Object2ObjectArrayMap(Object2ObjectMap<K,V> m)
Creates a new empty array map copying the entries of a given map.

Method Summary

void	clear() Removes all associations from this function (optional operation).
Object	clone() Returns a deep copy of this map.
boolean	containsKey(Object k) Checks whether the given value is contained in AbstractObject2ObjectMap.keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in AbstractObject2ObjectMap.values().
V	get(Object k) Returns the value associated by this function to the specified key.
boolean	isEmpty()
ObjectSet<K>	keySet() Returns a type-specific-set view of the keys of this map.
Object2ObjectMap.FastEntrySet<K,V>	object2ObjectEntrySet() Returns a type-specific set view of the mappings contained in this map.
V	put(K k, V v) Associates the specified value with the specified key in this function (optional operation).
V	remove(Object k) Removes this key and the associated value from this function if it is present (optional operation).
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
ObjectCollection<V>	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ObjectMap

entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ObjectFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ObjectFunction

defaultReturnValue, defaultReturnValue

Constructor Detail

Object2ObjectArrayMap

public Object2ObjectArrayMap(Object[] key,
                             Object[] value)

Creates a new empty array map with given key and value backing arrays.

Parameters:

key - the key array.

value - the value array (it must have the same length as key).

Object2ObjectArrayMap

public Object2ObjectArrayMap()

Creates a new empty array map.

Object2ObjectArrayMap

public Object2ObjectArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Object2ObjectArrayMap

public Object2ObjectArrayMap(Object2ObjectMap<K,V> m)

Creates a new empty array map copying the entries of a given map.

Parameters:

m - a map.

Object2ObjectArrayMap

public Object2ObjectArrayMap(Object[] key,
                             Object[] value,
                             int size)

Creates a new array map with given key and value backing arrays, using the given number of elements.

Parameters:

key - the key array.

value - the value array (it must have the same length as key).

size - the number of valid elements in key and value.

Method Detail

object2ObjectEntrySet

public Object2ObjectMap.FastEntrySet<K,V> object2ObjectEntrySet()

Description copied from interface: Object2ObjectMap

Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Object2ObjectMap.entrySet() so that it returns an ObjectSet of objects of type Object2ObjectMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

object2ObjectEntrySet in interface Object2ObjectMap<K,V>

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Object2ObjectMap.entrySet()

get

public V get(Object k)

Description copied from interface: Function

Returns the value associated by this function to the specified key.

Specified by:

get in interface Function<K,V>

Specified by:

get in interface Map<K,V>

Parameters:

k - the key.

Returns:

the corresponding value, or null if no value was present for the given key.

See Also:

Map.get(Object)

size

public int size()

Description copied from interface: Function

Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:

size in interface Function<K,V>

Specified by:

size in interface Map<K,V>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<K,V>

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractObject2ObjectFunction<K,V>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractObject2ObjectMap

Checks whether the given value is contained in AbstractObject2ObjectMap.keySet().

Specified by:

containsKey in interface Function<K,V>

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractObject2ObjectMap<K,V>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractObject2ObjectMap

Checks whether the given value is contained in AbstractObject2ObjectMap.values().

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractObject2ObjectMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractObject2ObjectMap<K,V>

put

public V put(K k,
             V v)

Description copied from interface: Function

Associates the specified value with the specified key in this function (optional operation).

Specified by:

put in interface Function<K,V>

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractObject2ObjectFunction<K,V>

Parameters:

k - the key.

v - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public V remove(Object k)

Description copied from interface: Function

Removes this key and the associated value from this function if it is present (optional operation).

Specified by:

remove in interface Function<K,V>

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractObject2ObjectFunction<K,V>

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

keySet

public ObjectSet<K> keySet()

Description copied from class: AbstractObject2ObjectMap

Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractObject2ObjectMap.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

keySet in interface Object2ObjectMap<K,V>

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractObject2ObjectMap<K,V>

Returns:

a set view of the keys of this map; it may be safely cast to a type-specific interface.

See Also:

Map.keySet()

values

public ObjectCollection<V> values()

Description copied from class: AbstractObject2ObjectMap

Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractObject2ObjectMap.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

values in interface Object2ObjectMap<K,V>

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractObject2ObjectMap<K,V>

Returns:

a set view of the values of this map; it may be safely cast to a type-specific interface.

See Also:

Map.values()

clone

public Object clone()

Returns a deep copy of this map.

This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:

clone in class Object

Returns:

a deep copy of this map.