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

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction<K,V>
      it.unimi.dsi.fastutil.objects.Object2ReferenceFunctions.SynchronizedFunction<K,V>
          it.unimi.dsi.fastutil.objects.Object2ReferenceMaps.SynchronizedMap<K,V>

All Implemented Interfaces:

Function<K,V>, Object2ReferenceFunction<K,V>, Object2ReferenceMap<K,V>, Serializable, Map<K,V>

Direct Known Subclasses:

Object2ReferenceSortedMaps.SynchronizedSortedMap

Enclosing class:

Object2ReferenceMaps

public static class Object2ReferenceMaps.SynchronizedMap<K,V>
extends Object2ReferenceFunctions.SynchronizedFunction<K,V>
implements Object2ReferenceMap<K,V>, Serializable

A synchronized wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(Object k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(Object v)
V	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(V defRetValue) Sets the default return value.
ObjectSet<Map.Entry<K,V>>	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(Object o)
V	get(Object k) Returns the value associated by this function to the specified key.
int	hashCode()
boolean	isEmpty()
ObjectSet<K>	keySet() Returns a set view of the keys contained in this map.
ObjectSet<Object2ReferenceMap.Entry<K,V>>	object2ReferenceEntrySet() 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).
void	putAll(Map<? extends K,? extends V> m)
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.
String	toString()
ReferenceCollection<V>	values() Returns a set view of the values contained in this map.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

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>

Overrides:

size in class Object2ReferenceFunctions.SynchronizedFunction<K,V>

Returns:

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

containsKey

public boolean containsKey(Object k)

Description copied from interface: Function

Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:

containsKey in interface Function<K,V>

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class Object2ReferenceFunctions.SynchronizedFunction<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)

Specified by:

containsValue in interface Map<K,V>

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Object2ReferenceFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2ReferenceFunction<K,V>

Overrides:

defaultReturnValue in class Object2ReferenceFunctions.SynchronizedFunction<K,V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Object2ReferenceFunction

Sets the default return value. This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.

Specified by:

defaultReturnValue in interface Object2ReferenceFunction<K,V>

Overrides:

defaultReturnValue in class Object2ReferenceFunctions.SynchronizedFunction<K,V>

Parameters:

defRetValue - the new default return value.

See Also:

Object2ReferenceFunction.defaultReturnValue()

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 Object2ReferenceFunctions.SynchronizedFunction<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)

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

object2ReferenceEntrySet

public ObjectSet<Object2ReferenceMap.Entry<K,V>> object2ReferenceEntrySet()

Description copied from interface: Object2ReferenceMap

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 Object2ReferenceMap.entrySet() so that it returns an ObjectSet of objects of type Object2ReferenceMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

object2ReferenceEntrySet in interface Object2ReferenceMap<K,V>

Returns:

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

See Also:

Object2ReferenceMap.entrySet()

keySet

public ObjectSet<K> keySet()

Description copied from interface: Object2ReferenceMap

Returns a set view of the keys contained in this map.

Note that this specification strengthens the one given in Map.keySet().

Specified by:

keySet in interface Object2ReferenceMap<K,V>

Specified by:

keySet in interface Map<K,V>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ReferenceCollection<V> values()

Description copied from interface: Object2ReferenceMap

Returns a set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values().

Specified by:

values in interface Object2ReferenceMap<K,V>

Specified by:

values in interface Map<K,V>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

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 Object2ReferenceFunctions.SynchronizedFunction<K,V>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object2ReferenceFunctions.SynchronizedFunction<K,V>

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 Object2ReferenceFunctions.SynchronizedFunction<K,V>

Returns:

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

See Also:

Map.remove(Object)

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>

Overrides:

get in class Object2ReferenceFunctions.SynchronizedFunction<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)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

entrySet

public ObjectSet<Map.Entry<K,V>> entrySet()

Description copied from interface: Object2ReferenceMap

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

Note that this specification strengthens the one given in Map.entrySet().

Specified by:

entrySet in interface Object2ReferenceMap<K,V>

Specified by:

entrySet in interface Map<K,V>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object