Package it.unimi.dsi.fastutil.objects
Class Reference2IntMaps
- java.lang.Object
-
- it.unimi.dsi.fastutil.objects.Reference2IntMaps
-
public final class Reference2IntMaps extends Object
A class providing static methods and objects that do useful things with type-specific maps.- See Also:
Collections
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Reference2IntMaps.EmptyMap<K>
An immutable class representing an empty type-specific map.static class
Reference2IntMaps.Singleton<K>
An immutable class representing a type-specific singleton map.static class
Reference2IntMaps.SynchronizedMap<K>
A synchronized wrapper class for maps.static class
Reference2IntMaps.UnmodifiableMap<K>
An unmodifiable wrapper class for maps.
-
Field Summary
Fields Modifier and Type Field Description static Reference2IntMaps.EmptyMap
EMPTY_MAP
An empty type-specific map (immutable).
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <K> Reference2IntMap<K>
emptyMap()
Returns an empty map (immutable).static <K> void
fastForEach(Reference2IntMap<K> map, Consumer<? super Reference2IntMap.Entry<K>> consumer)
static <K> ObjectIterable<Reference2IntMap.Entry<K>>
fastIterable(Reference2IntMap<K> map)
static <K> ObjectIterator<Reference2IntMap.Entry<K>>
fastIterator(Reference2IntMap<K> map)
static <K> Reference2IntMap<K>
singleton(K key, int value)
Returns a type-specific immutable map containing only the specified pair.static <K> Reference2IntMap<K>
singleton(K key, Integer value)
Returns a type-specific immutable map containing only the specified pair.static <K> Reference2IntMap<K>
synchronize(Reference2IntMap<K> m)
Returns a synchronized type-specific map backed by the given type-specific map.static <K> Reference2IntMap<K>
synchronize(Reference2IntMap<K> m, Object sync)
Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.static <K> Reference2IntMap<K>
unmodifiable(Reference2IntMap<K> m)
Returns an unmodifiable type-specific map backed by the given type-specific map.
-
-
-
Field Detail
-
EMPTY_MAP
public static final Reference2IntMaps.EmptyMap EMPTY_MAP
An empty type-specific map (immutable). It is serializable and cloneable.
-
-
Method Detail
-
fastIterator
public static <K> ObjectIterator<Reference2IntMap.Entry<K>> fastIterator(Reference2IntMap<K> map)
- Parameters:
map
- a map from which we will try to extract a (fast) iterator on the entry set.- Returns:
- an iterator on the entry set of the given map that will be fast, if possible.
- Since:
- 8.0.0
-
fastForEach
public static <K> void fastForEach(Reference2IntMap<K> map, Consumer<? super Reference2IntMap.Entry<K>> consumer)
- Parameters:
map
- a map on which we will try to iterate quickly.consumer
- the consumer that will be passed toReference2IntMap.FastEntrySet.fastForEach(Consumer)
, if possible, or toIterable.forEach(Consumer)
.- Since:
- 8.1.0
-
fastIterable
public static <K> ObjectIterable<Reference2IntMap.Entry<K>> fastIterable(Reference2IntMap<K> map)
Returns an iterable yielding an iterator that will be fast, if possible, on the entry set of the providedmap
.- Parameters:
map
- a map from which we will try to extract an iterable yielding a (fast) iterator on the entry set.- Returns:
- an iterable yielding an iterator on the entry set of the given map that will be fast, if possible.
- Since:
- 8.0.0
-
emptyMap
public static <K> Reference2IntMap<K> emptyMap()
Returns an empty map (immutable). It is serializable and cloneable.This method provides a typesafe access to
EMPTY_MAP
.- Returns:
- an empty map (immutable).
-
singleton
public static <K> Reference2IntMap<K> singleton(K key, int value)
Returns a type-specific immutable map containing only the specified pair. The returned map is serializable and cloneable.Note that albeit the returned map is immutable, its default return value may be changed.
- Parameters:
key
- the only key of the returned map.value
- the only value of the returned map.- Returns:
- a type-specific immutable map containing just the pair
<key,value>
.
-
singleton
public static <K> Reference2IntMap<K> singleton(K key, Integer value)
Returns a type-specific immutable map containing only the specified pair. The returned map is serializable and cloneable.Note that albeit the returned map is immutable, its default return value may be changed.
- Parameters:
key
- the only key of the returned map.value
- the only value of the returned map.- Returns:
- a type-specific immutable map containing just the pair
<key,value>
.
-
synchronize
public static <K> Reference2IntMap<K> synchronize(Reference2IntMap<K> m)
Returns a synchronized type-specific map backed by the given type-specific map.- Parameters:
m
- the map to be wrapped in a synchronized map.- Returns:
- a synchronized view of the specified map.
- See Also:
Collections.synchronizedMap(Map)
-
synchronize
public static <K> Reference2IntMap<K> synchronize(Reference2IntMap<K> m, Object sync)
Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.- Parameters:
m
- the map to be wrapped in a synchronized map.sync
- an object that will be used to synchronize the access to the map.- Returns:
- a synchronized view of the specified map.
- See Also:
Collections.synchronizedMap(Map)
-
unmodifiable
public static <K> Reference2IntMap<K> unmodifiable(Reference2IntMap<K> m)
Returns an unmodifiable type-specific map backed by the given type-specific map.- Parameters:
m
- the map to be wrapped in an unmodifiable map.- Returns:
- an unmodifiable view of the specified map.
- See Also:
Collections.unmodifiableMap(Map)
-
-