it.unimi.dsi.fastutil.objects
Class Object2FloatMaps.SynchronizedMap<K>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2FloatFunction<K>
      extended by it.unimi.dsi.fastutil.objects.Object2FloatFunctions.SynchronizedFunction<K>
          extended by it.unimi.dsi.fastutil.objects.Object2FloatMaps.SynchronizedMap<K>
All Implemented Interfaces:
Function<K,Float>, Object2FloatFunction<K>, Object2FloatMap<K>, Serializable, Map<K,Float>
Direct Known Subclasses:
Object2FloatSortedMaps.SynchronizedSortedMap
Enclosing class:
Object2FloatMaps

public static class Object2FloatMaps.SynchronizedMap<K>
extends Object2FloatFunctions.SynchronizedFunction<K>
implements Object2FloatMap<K>, 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.Object2FloatMap
Object2FloatMap.Entry<K>, Object2FloatMap.FastEntrySet<K>
 
Field Summary
protected  ObjectSet<Object2FloatMap.Entry<K>> entries
           
protected  ObjectSet<K> keys
           
protected  Object2FloatMap<K> map
           
static long serialVersionUID
           
protected  FloatCollection values
           
 
Fields inherited from class it.unimi.dsi.fastutil.objects.Object2FloatFunctions.SynchronizedFunction
function, sync
 
Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2FloatFunction
defRetValue
 
Constructor Summary
protected Object2FloatMaps.SynchronizedMap(Object2FloatMap<K> m)
           
protected Object2FloatMaps.SynchronizedMap(Object2FloatMap<K> m, Object sync)
           
 
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(float v)
           
 boolean containsValue(Object ov)
           
 float defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(float defRetValue)
          Sets the default return value.
 ObjectSet<Map.Entry<K,Float>> entrySet()
          Returns a set view of the mappings contained in this map.
 boolean equals(Object o)
           
 float getFloat(Object k)
          Returns the value to which the given key is mapped.
 int hashCode()
           
 boolean isEmpty()
           
 ObjectSet<K> keySet()
          Returns a set view of the keys contained in this map.
 ObjectSet<Object2FloatMap.Entry<K>> object2FloatEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 float put(K k, float v)
          Adds a pair to the map.
 Float put(K k, Float v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 void putAll(Map<? extends K,? extends Float> m)
           
 float removeFloat(Object 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.
 String toString()
           
 FloatCollection values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.Object2FloatFunctions.SynchronizedFunction
get, remove
 
Methods inherited from class java.lang.Object
clone, finalize, 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

map

protected final Object2FloatMap<K> map

entries

protected transient volatile ObjectSet<Object2FloatMap.Entry<K>> entries

keys

protected transient volatile ObjectSet<K> keys

values

protected transient volatile FloatCollection values
Constructor Detail

Object2FloatMaps.SynchronizedMap

protected Object2FloatMaps.SynchronizedMap(Object2FloatMap<K> m,
                                           Object sync)

Object2FloatMaps.SynchronizedMap

protected Object2FloatMaps.SynchronizedMap(Object2FloatMap<K> m)
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,Float>
Specified by:
size in interface Map<K,Float>
Overrides:
size in class Object2FloatFunctions.SynchronizedFunction<K>
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,Float>
Specified by:
containsKey in interface Map<K,Float>
Overrides:
containsKey in class Object2FloatFunctions.SynchronizedFunction<K>
Parameters:
k - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

containsValue

public boolean containsValue(float v)
Specified by:
containsValue in interface Object2FloatMap<K>
See Also:
Map.containsValue(Object)

defaultReturnValue

public float defaultReturnValue()
Description copied from interface: Object2FloatFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Object2FloatFunction<K>
Overrides:
defaultReturnValue in class Object2FloatFunctions.SynchronizedFunction<K>
Returns:
the current default return value.

defaultReturnValue

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

put

public float put(K k,
                 float v)
Description copied from interface: Object2FloatFunction
Adds a pair to the map.

Specified by:
put in interface Object2FloatFunction<K>
Overrides:
put in class Object2FloatFunctions.SynchronizedFunction<K>
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(Map<? extends K,? extends Float> m)
Specified by:
putAll in interface Map<K,Float>

object2FloatEntrySet

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

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

keySet

public ObjectSet<K> keySet()
Description copied from interface: Object2FloatMap
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 Object2FloatMap<K>
Specified by:
keySet in interface Map<K,Float>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

public FloatCollection values()
Description copied from interface: Object2FloatMap
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 Object2FloatMap<K>
Specified by:
values in interface Map<K,Float>
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,Float>
Specified by:
clear in interface Map<K,Float>
Overrides:
clear in class Object2FloatFunctions.SynchronizedFunction<K>
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Object2FloatFunctions.SynchronizedFunction<K>

put

public Float put(K k,
                 Float v)
Description copied from class: AbstractObject2FloatFunction
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<K,Float>
Specified by:
put in interface Map<K,Float>
Overrides:
put in class Object2FloatFunctions.SynchronizedFunction<K>
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)

containsValue

public boolean containsValue(Object ov)
Specified by:
containsValue in interface Map<K,Float>

removeFloat

public float removeFloat(Object k)
Description copied from interface: Object2FloatFunction
Removes the mapping with the given key.

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

getFloat

public float getFloat(Object k)
Description copied from interface: Object2FloatFunction
Returns the value to which the given key is mapped.

Specified by:
getFloat in interface Object2FloatFunction<K>
Overrides:
getFloat in class Object2FloatFunctions.SynchronizedFunction<K>
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)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map<K,Float>

entrySet

public ObjectSet<Map.Entry<K,Float>> entrySet()
Description copied from interface: Object2FloatMap
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 Object2FloatMap<K>
Specified by:
entrySet in interface Map<K,Float>
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,Float>
Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Specified by:
equals in interface Map<K,Float>
Overrides:
equals in class Object


Copyright © 2011. All Rights Reserved.