Interface Reference2ObjectMap<K,V>
-
- All Superinterfaces:
Function<K,V>
,java.util.function.Function<K,V>
,java.util.Map<K,V>
,Reference2ObjectFunction<K,V>
- All Known Subinterfaces:
Reference2ObjectSortedMap<K,V>
- All Known Implementing Classes:
AbstractReference2ObjectMap
,AbstractReference2ObjectSortedMap
,Reference2ObjectArrayMap
,Reference2ObjectLinkedOpenHashMap
,Reference2ObjectMaps.EmptyMap
,Reference2ObjectMaps.Singleton
,Reference2ObjectMaps.SynchronizedMap
,Reference2ObjectMaps.UnmodifiableMap
,Reference2ObjectOpenCustomHashMap
,Reference2ObjectOpenHashMap
,Reference2ObjectSortedMaps.EmptySortedMap
,Reference2ObjectSortedMaps.Singleton
,Reference2ObjectSortedMaps.SynchronizedSortedMap
,Reference2ObjectSortedMaps.UnmodifiableSortedMap
public interface Reference2ObjectMap<K,V> extends Reference2ObjectFunction<K,V>, java.util.Map<K,V>
A type-specificMap
; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.Besides extending the corresponding type-specific function, this interface strengthens
Map.entrySet()
,keySet()
andvalues()
. Moreover, a number of methods, such assize()
,defaultReturnValue()
, etc., are un-defaulted as their function default do not make sense for a map. Maps returning entry sets of typeReference2ObjectMap.FastEntrySet
support also fast iteration.A submap or subset may or may not have an independent default return value (which however must be initialized to the default return value of the originator).
- See Also:
Map
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Reference2ObjectMap.Entry<K,V>
A type-specificMap.Entry
; provides some additional methods that use polymorphism to avoid (un)boxing.static interface
Reference2ObjectMap.FastEntrySet<K,V>
An entry set providing fast iteration.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
clear()
Removes all of the mappings from this map (optional operation).boolean
containsKey(java.lang.Object key)
Returns true if this function contains a mapping for the specified key.V
defaultReturnValue()
Gets the default return value.void
defaultReturnValue(V rv)
Sets the default return value (optional operation).default ObjectSet<java.util.Map.Entry<K,V>>
entrySet()
Returns a set view of the mappings contained in this map.ReferenceSet<K>
keySet()
default V
put(K key, V value)
Adds a pair to the map (optional operation).ObjectSet<Reference2ObjectMap.Entry<K,V>>
reference2ObjectEntrySet()
Returns a type-specific set view of the mappings contained in this map.default V
remove(java.lang.Object key)
Removes the mapping with the given key (optional operation).int
size()
Returns the number of key/value mappings in this map.ObjectCollection<V>
values()
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll
-
Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2ObjectFunction
get
-
-
-
-
Method Detail
-
size
int size()
Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.
-
clear
default void clear()
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
-
defaultReturnValue
void defaultReturnValue(V rv)
Sets the default return value (optional operation). This value must be returned by type-specific versions ofget()
,put()
andremove()
to denote that the map does not contain the specified key. It must benull
by default.Warning: Changing this to a non-null value can have unforeseen consequences. Especially, it breaks compatibility with the specifications of Java's
Map
interface. It has to be used with great care and thorough study of all method comments is recommended.- Specified by:
defaultReturnValue
in interfaceReference2ObjectFunction<K,V>
- Parameters:
rv
- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
V defaultReturnValue()
Gets the default return value.- Specified by:
defaultReturnValue
in interfaceReference2ObjectFunction<K,V>
- Returns:
- the current default return value.
-
reference2ObjectEntrySet
ObjectSet<Reference2ObjectMap.Entry<K,V>> reference2ObjectEntrySet()
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
Map.entrySet()
so that it returns anObjectSet
of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
Map.entrySet()
-
entrySet
default ObjectSet<java.util.Map.Entry<K,V>> entrySet()
Returns a set view of the mappings contained in this map.Note that this specification strengthens the one given in
Map.entrySet()
.
-
put
default V put(K key, V value)
Adds a pair to the map (optional operation).This default implementation just delegates to the corresponding function method.
- Specified by:
put
in interfaceFunction<K,V>
- Specified by:
put
in interfacejava.util.Map<K,V>
- Specified by:
put
in interfaceReference2ObjectFunction<K,V>
- 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:
Function.put(Object,Object)
-
remove
default V remove(java.lang.Object key)
Removes the mapping with the given key (optional operation).This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
remove
in interfaceFunction<K,V>
- Specified by:
remove
in interfacejava.util.Map<K,V>
- Specified by:
remove
in interfaceReference2ObjectFunction<K,V>
- Parameters:
key
- the key.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
Function.remove(Object)
-
keySet
ReferenceSet<K> keySet()
Note that this specification strengthens the one given in
Map.keySet()
.
-
values
ObjectCollection<V> values()
Note that this specification strengthens the one given in
Map.values()
.
-
containsKey
boolean containsKey(java.lang.Object key)
Returns true if this function contains a mapping for the specified key.
-
-