it.unimi.dsi.fastutil.chars
Interface Char2ReferenceMap<V>

All Superinterfaces:
Char2ReferenceFunction<V>, Function<Character,V>, Map<Character,V>
All Known Subinterfaces:
Char2ReferenceSortedMap<V>
All Known Implementing Classes:
AbstractChar2ReferenceMap, AbstractChar2ReferenceSortedMap, Char2ReferenceArrayMap, Char2ReferenceAVLTreeMap, Char2ReferenceLinkedOpenHashMap, Char2ReferenceMaps.EmptyMap, Char2ReferenceMaps.Singleton, Char2ReferenceMaps.SynchronizedMap, Char2ReferenceMaps.UnmodifiableMap, Char2ReferenceOpenHashMap, Char2ReferenceRBTreeMap, Char2ReferenceSortedMaps.EmptySortedMap, Char2ReferenceSortedMaps.Singleton, Char2ReferenceSortedMaps.SynchronizedSortedMap, Char2ReferenceSortedMaps.UnmodifiableSortedMap

public interface Char2ReferenceMap<V>
extends Char2ReferenceFunction<V>, Map<Character,V>

A type-specific Map; 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 entrySet(), keySet() and values(). Maps returning entry sets of type Char2ReferenceMap.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
static interface Char2ReferenceMap.Entry<V>
          A type-specific Map.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.
static interface Char2ReferenceMap.FastEntrySet<V>
          An entry set providing fast iteration.
 
Method Summary
 ObjectSet<Char2ReferenceMap.Entry<V>> char2ReferenceEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 ObjectSet<Map.Entry<Character,V>> entrySet()
          Returns a set view of the mappings contained in this map.
 CharSet keySet()
          Returns a set view of the keys contained in this map.
 ReferenceCollection<V> values()
          Returns a set view of the values contained in this map.
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ReferenceFunction
containsKey, defaultReturnValue, defaultReturnValue, get, put, remove
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
clear, containsKey, get, put, remove, size
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size
 

Method Detail

entrySet

ObjectSet<Map.Entry<Character,V>> entrySet()
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 Map<Character,V>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()

char2ReferenceEntrySet

ObjectSet<Char2ReferenceMap.Entry<V>> char2ReferenceEntrySet()
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 entrySet() so that it returns an ObjectSet of objects of type Char2ReferenceMap.Entry (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:
entrySet()

keySet

CharSet keySet()
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 Map<Character,V>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

ReferenceCollection<V> values()
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 Map<Character,V>
Returns:
a set view of the values contained in this map.
See Also:
Map.values()