it.unimi.dsi.fastutil.objects
Class Reference2ObjectMaps.UnmodifiableMap<K,V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractReference2ObjectFunction<K,V>
      extended by it.unimi.dsi.fastutil.objects.Reference2ObjectFunctions.UnmodifiableFunction<K,V>
          extended by it.unimi.dsi.fastutil.objects.Reference2ObjectMaps.UnmodifiableMap<K,V>
All Implemented Interfaces:
Function<K,V>, Reference2ObjectFunction<K,V>, Reference2ObjectMap<K,V>, java.io.Serializable, java.util.Map<K,V>
Direct Known Subclasses:
Reference2ObjectSortedMaps.UnmodifiableSortedMap
Enclosing class:
Reference2ObjectMaps

public static class Reference2ObjectMaps.UnmodifiableMap<K,V>
extends Reference2ObjectFunctions.UnmodifiableFunction<K,V>
implements Reference2ObjectMap<K,V>, java.io.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.Reference2ObjectMap
Reference2ObjectMap.Entry<K,V>, Reference2ObjectMap.FastEntrySet<K,V>
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(java.lang.Object k)
          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<K,V>> entrySet()
          Returns a set view of the mappings contained in this map.
 V get(java.lang.Object k)
          Returns the value associated by this function to the specified key.
 boolean isEmpty()
           
 ReferenceSet<K> keySet()
          Returns a set view of the keys 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(java.util.Map<? extends K,? extends V> m)
           
 ObjectSet<Reference2ObjectMap.Entry<K,V>> reference2ObjectEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 V remove(java.lang.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.
 java.lang.String toString()
           
 ObjectCollection<V> values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

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 java.util.Map<K,V>
Overrides:
size in class Reference2ObjectFunctions.UnmodifiableFunction<K,V>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(java.lang.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 java.util.Map<K,V>
Overrides:
containsKey in class Reference2ObjectFunctions.UnmodifiableFunction<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(java.lang.Object v)
Specified by:
containsValue in interface java.util.Map<K,V>

defaultReturnValue

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

Specified by:
defaultReturnValue in interface Reference2ObjectFunction<K,V>
Overrides:
defaultReturnValue in class Reference2ObjectFunctions.UnmodifiableFunction<K,V>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)
Description copied from interface: Reference2ObjectFunction
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 Reference2ObjectFunction<K,V>
Overrides:
defaultReturnValue in class Reference2ObjectFunctions.UnmodifiableFunction<K,V>
Parameters:
defRetValue - the new default return value.
See Also:
Reference2ObjectFunction.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 java.util.Map<K,V>
Overrides:
put in class Reference2ObjectFunctions.UnmodifiableFunction<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(java.util.Map<? extends K,? extends V> m)
Specified by:
putAll in interface java.util.Map<K,V>

reference2ObjectEntrySet

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

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

keySet

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

values

public ObjectCollection<V> values()
Description copied from interface: Reference2ObjectMap
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 Reference2ObjectMap<K,V>
Specified by:
values in interface java.util.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 java.util.Map<K,V>
Overrides:
clear in class Reference2ObjectFunctions.UnmodifiableFunction<K,V>
See Also:
Map.clear()

toString

public java.lang.String toString()
Overrides:
toString in class Reference2ObjectFunctions.UnmodifiableFunction<K,V>

remove

public V remove(java.lang.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 java.util.Map<K,V>
Overrides:
remove in class Reference2ObjectFunctions.UnmodifiableFunction<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(java.lang.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 java.util.Map<K,V>
Overrides:
get in class Reference2ObjectFunctions.UnmodifiableFunction<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 java.util.Map<K,V>

entrySet

public ObjectSet<java.util.Map.Entry<K,V>> entrySet()
Description copied from interface: Reference2ObjectMap
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 Reference2ObjectMap<K,V>
Specified by:
entrySet in interface java.util.Map<K,V>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()