it.unimi.dsi.fastutil.ints
Class Int2ReferenceMaps.SynchronizedMap<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction<V>
      extended by it.unimi.dsi.fastutil.ints.Int2ReferenceFunctions.SynchronizedFunction<V>
          extended by it.unimi.dsi.fastutil.ints.Int2ReferenceMaps.SynchronizedMap<V>
All Implemented Interfaces:
Function<java.lang.Integer,V>, Int2ReferenceFunction<V>, Int2ReferenceMap<V>, java.io.Serializable, java.util.Map<java.lang.Integer,V>
Direct Known Subclasses:
Int2ReferenceSortedMaps.SynchronizedSortedMap
Enclosing class:
Int2ReferenceMaps

public static class Int2ReferenceMaps.SynchronizedMap<V>
extends Int2ReferenceFunctions.SynchronizedFunction<V>
implements Int2ReferenceMap<V>, java.io.Serializable

A synchronized wrapper class for maps.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceMap
Int2ReferenceMap.Entry<V>, Int2ReferenceMap.FastEntrySet<V>
 
Field Summary
static long serialVersionUID
           
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(int k)
           
 boolean containsKey(java.lang.Object ok)
          Returns true if this function contains a mapping for the specified key.
 boolean containsValue(java.lang.Object v)
           
 V defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(V defRetValue)
          Sets the default return value.
 ObjectSet<java.util.Map.Entry<java.lang.Integer,V>> entrySet()
          Returns a set view of the mappings contained in this map.
 boolean equals(java.lang.Object o)
           
 V get(int k)
          Returns the value to which the given key is mapped.
 int hashCode()
           
 ObjectSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 boolean isEmpty()
           
 IntSet keySet()
          Returns a set view of the keys contained in this map.
 V put(java.lang.Integer k, V v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 V put(int k, V v)
          Adds a pair to the map.
 void putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
           
 V remove(int k)
          Removes the mapping with the given key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 java.lang.String toString()
           
 ReferenceCollection<V> values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.ints.Int2ReferenceFunctions.SynchronizedFunction
get, remove
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
get, remove
 
Methods inherited from interface java.util.Map
get, remove
 

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<java.lang.Integer,V>
Specified by:
size in interface java.util.Map<java.lang.Integer,V>
Overrides:
size in class Int2ReferenceFunctions.SynchronizedFunction<V>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(int k)
Specified by:
containsKey in interface Int2ReferenceFunction<V>
Overrides:
containsKey in class Int2ReferenceFunctions.SynchronizedFunction<V>
See Also:
Function.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object v)
Specified by:
containsValue in interface java.util.Map<java.lang.Integer,V>

defaultReturnValue

public V defaultReturnValue()
Description copied from interface: Int2ReferenceFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Int2ReferenceFunction<V>
Overrides:
defaultReturnValue in class Int2ReferenceFunctions.SynchronizedFunction<V>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)
Description copied from interface: Int2ReferenceFunction
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 Int2ReferenceFunction<V>
Overrides:
defaultReturnValue in class Int2ReferenceFunctions.SynchronizedFunction<V>
Parameters:
defRetValue - the new default return value.
See Also:
Int2ReferenceFunction.defaultReturnValue()

put

public V put(int k,
             V v)
Description copied from interface: Int2ReferenceFunction
Adds a pair to the map.

Specified by:
put in interface Int2ReferenceFunction<V>
Overrides:
put in class Int2ReferenceFunctions.SynchronizedFunction<V>
Parameters:
k - the key.
v - the value.
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.put(Object,Object)

putAll

public void putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
Specified by:
putAll in interface java.util.Map<java.lang.Integer,V>

int2ReferenceEntrySet

public ObjectSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
Description copied from interface: Int2ReferenceMap
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 Int2ReferenceMap.entrySet() so that it returns an ObjectSet of objects of type Int2ReferenceMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
int2ReferenceEntrySet in interface Int2ReferenceMap<V>
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Int2ReferenceMap.entrySet()

keySet

public IntSet keySet()
Description copied from interface: Int2ReferenceMap
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 Int2ReferenceMap<V>
Specified by:
keySet in interface java.util.Map<java.lang.Integer,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: Int2ReferenceMap
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 Int2ReferenceMap<V>
Specified by:
values in interface java.util.Map<java.lang.Integer,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<java.lang.Integer,V>
Specified by:
clear in interface java.util.Map<java.lang.Integer,V>
Overrides:
clear in class Int2ReferenceFunctions.SynchronizedFunction<V>
See Also:
Map.clear()

toString

public java.lang.String toString()
Overrides:
toString in class Int2ReferenceFunctions.SynchronizedFunction<V>

put

public V put(java.lang.Integer k,
             V v)
Description copied from class: AbstractInt2ReferenceFunction
Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:
put in interface Function<java.lang.Integer,V>
Specified by:
put in interface java.util.Map<java.lang.Integer,V>
Overrides:
put in class Int2ReferenceFunctions.SynchronizedFunction<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(int k)
Description copied from interface: Int2ReferenceFunction
Removes the mapping with the given key.

Specified by:
remove in interface Int2ReferenceFunction<V>
Overrides:
remove in class Int2ReferenceFunctions.SynchronizedFunction<V>
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

get

public V get(int k)
Description copied from interface: Int2ReferenceFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Int2ReferenceFunction<V>
Overrides:
get in class Int2ReferenceFunctions.SynchronizedFunction<V>
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Function.get(Object)

containsKey

public boolean containsKey(java.lang.Object ok)
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<java.lang.Integer,V>
Specified by:
containsKey in interface java.util.Map<java.lang.Integer,V>
Overrides:
containsKey in class Int2ReferenceFunctions.SynchronizedFunction<V>
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.Integer,V>

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Integer,V>> entrySet()
Description copied from interface: Int2ReferenceMap
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 Int2ReferenceMap<V>
Specified by:
entrySet in interface java.util.Map<java.lang.Integer,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 java.util.Map<java.lang.Integer,V>
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Map<java.lang.Integer,V>
Overrides:
equals in class java.lang.Object