it.unimi.dsi.fastutil.doubles
Interface Double2ObjectMap

All Superinterfaces:
Map
All Known Subinterfaces:
Double2ObjectSortedMap
All Known Implementing Classes:
AbstractDouble2ObjectMap, Double2ObjectAVLTreeMap, Double2ObjectLinkedOpenHashMap, Double2ObjectOpenHashMap, Double2ObjectRBTreeMap

public interface Double2ObjectMap
extends Map

A type-specific Map; provides some additional methods that use polymorphism to reduce type juggling.

See Also:
Map

Nested Class Summary
static interface Double2ObjectMap.Entry
          A type-specific Map.Entry; provides some additional methods to access its content reducing type juggling.
 
Method Summary
 boolean containsKey(double key)
           
 Object defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(Object rv)
          Sets the default return value.
 Object get(double key)
          Returns the value to which the given key is mapped.
 Object getDefRetValue()
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 Object put(double key, Object value)
          Adds a pair to the map.
 Object remove(double key)
          Removes the mapping with the given key.
 void setDefRetValue(Object rv)
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

put

public Object put(double key,
                  Object value)
Adds a pair to the map.

Parameters:
key - the key.
value - the value.
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Map.put(Object,Object)

get

public Object get(double key)
Returns the value to which the given key is mapped.

Parameters:
key - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

remove

public Object remove(double key)
Removes the mapping with the given key.

Parameters:
key -
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Map.remove(Object)

containsKey

public boolean containsKey(double key)
See Also:
Map.containsKey(Object)

setDefRetValue

public void setDefRetValue(Object rv)
Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().

Sets the default return value. This value is returned by get(), put() and remove() to denote that the map does not contain the specified key. It is 0/false/null by default.

Parameters:
rv - the new default return value.
See Also:
getDefRetValue(), defaultReturnValue()

getDefRetValue

public Object getDefRetValue()
Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().

Gets the default return value.

Returns:
the current default return value.
See Also:
defaultReturnValue()

defaultReturnValue

public void defaultReturnValue(Object rv)
Sets the default return value. This value is returned by get(), put() and remove() to denote that the map does not contain the specified key. It is 0/false/null by default.

Parameters:
rv - the new default return value.
See Also:
defaultReturnValue()

defaultReturnValue

public Object defaultReturnValue()
Gets the default return value.

Returns:
the current default return value.