it.unimi.dsi.fastutil.objects
Class Reference2DoubleMaps.UnmodifiableMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractReference2DoubleFunction<K>
      it.unimi.dsi.fastutil.objects.Reference2DoubleFunctions.UnmodifiableFunction<K>
          it.unimi.dsi.fastutil.objects.Reference2DoubleMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,Double>, Reference2DoubleFunction<K>, Reference2DoubleMap<K>, Serializable, Map<K,Double>

Direct Known Subclasses:

Reference2DoubleSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2DoubleMaps

public static class Reference2DoubleMaps.UnmodifiableMap<K>
extends Reference2DoubleFunctions.UnmodifiableFunction<K>
implements Reference2DoubleMap<K>, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

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

Reference2DoubleMap.Entry<K>, Reference2DoubleMap.FastEntrySet<K>

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(double v)
boolean	containsValue(Object ov)
double	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(double defRetValue) Sets the default return value.
ObjectSet<Map.Entry<K,Double>>	entrySet() Returns a set view of the mappings contained in this map.
double	getDouble(Object k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ReferenceSet<K>	keySet() Returns a set view of the keys contained in this map.
double	put(K k, double v) Adds a pair to the map.
void	putAll(Map<? extends K,? extends Double> m)
ObjectSet<Reference2DoubleMap.Entry<K>>	reference2DoubleEntrySet() Returns a type-specific set view of the mappings contained in this map.
double	removeDouble(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()
DoubleCollection	values() Returns a set view of the values contained in this map.

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

get, put, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.Function

get, put, remove

Methods inherited from interface java.util.Map

equals, get, hashCode, put, 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<K,Double>

Specified by:

size in interface Map<K,Double>

Overrides:

size in class Reference2DoubleFunctions.UnmodifiableFunction<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,Double>

Specified by:

containsKey in interface Map<K,Double>

Overrides:

containsKey in class Reference2DoubleFunctions.UnmodifiableFunction<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(double v)

Specified by:

containsValue in interface Reference2DoubleMap<K>

See Also:

Map.containsValue(Object)

defaultReturnValue

public double defaultReturnValue()

Description copied from interface: Reference2DoubleFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Reference2DoubleFunction<K>

Overrides:

defaultReturnValue in class Reference2DoubleFunctions.UnmodifiableFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(double defRetValue)

Description copied from interface: Reference2DoubleFunction

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 Reference2DoubleFunction<K>

Overrides:

defaultReturnValue in class Reference2DoubleFunctions.UnmodifiableFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Reference2DoubleFunction.defaultReturnValue()

put

public double put(K k,
                  double v)

Description copied from interface: Reference2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Reference2DoubleFunction<K>

Overrides:

put in class Reference2DoubleFunctions.UnmodifiableFunction<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 Double> m)

Specified by:

putAll in interface Map<K,Double>

reference2DoubleEntrySet

public ObjectSet<Reference2DoubleMap.Entry<K>> reference2DoubleEntrySet()

Description copied from interface: Reference2DoubleMap

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

Specified by:

reference2DoubleEntrySet in interface Reference2DoubleMap<K>

Returns:

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

See Also:

Reference2DoubleMap.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2DoubleMap

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 Reference2DoubleMap<K>

Specified by:

keySet in interface Map<K,Double>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public DoubleCollection values()

Description copied from interface: Reference2DoubleMap

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 Reference2DoubleMap<K>

Specified by:

values in interface Map<K,Double>

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,Double>

Specified by:

clear in interface Map<K,Double>

Overrides:

clear in class Reference2DoubleFunctions.UnmodifiableFunction<K>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Reference2DoubleFunctions.UnmodifiableFunction<K>

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map<K,Double>

removeDouble

public double removeDouble(Object k)

Description copied from interface: Reference2DoubleFunction

Removes the mapping with the given key.

Specified by:

removeDouble in interface Reference2DoubleFunction<K>

Overrides:

removeDouble in class Reference2DoubleFunctions.UnmodifiableFunction<K>

Returns:

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

See Also:

Function.remove(Object)

getDouble

public double getDouble(Object k)

Description copied from interface: Reference2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

getDouble in interface Reference2DoubleFunction<K>

Overrides:

getDouble in class Reference2DoubleFunctions.UnmodifiableFunction<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,Double>

entrySet

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

Description copied from interface: Reference2DoubleMap

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 Reference2DoubleMap<K>

Specified by:

entrySet in interface Map<K,Double>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()