it.unimi.dsi.fastutil.shorts

Class Short2CharMaps

java.lang.Object

it.unimi.dsi.fastutil.shorts.Short2CharMaps

public final class Short2CharMaps
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 and Description
static class	Short2CharMaps.EmptyMap An immutable class representing an empty type-specific map.
static class	Short2CharMaps.Singleton An immutable class representing a type-specific singleton map.
static class	Short2CharMaps.SynchronizedMap A synchronized wrapper class for maps.
static class	Short2CharMaps.UnmodifiableMap An unmodifiable wrapper class for maps.

Field Summary

Fields

Modifier and Type	Field and Description
static Short2CharMaps.EmptyMap	EMPTY_MAP An empty type-specific map (immutable).

Method Summary

Modifier and Type	Method and Description
static void	fastForEach(Short2CharMap map, Consumer<? super Short2CharMap.Entry> consumer) Iterates quickly, if possible, on the entry set of the provided map.
static ObjectIterable<Short2CharMap.Entry>	fastIterable(Short2CharMap map) Returns an iterable yielding an iterator that will be fast, if possible, on the entry set of the provided map.
static ObjectIterator<Short2CharMap.Entry>	fastIterator(Short2CharMap map) Returns an iterator that will be fast, if possible, on the entry set of the provided map.
static Short2CharMap	singleton(short key, char value) Returns a type-specific immutable map containing only the specified pair.
static Short2CharMap	singleton(Short key, Character value) Returns a type-specific immutable map containing only the specified pair.
static Short2CharMap	synchronize(Short2CharMap m) Returns a synchronized type-specific map backed by the given type-specific map.
static Short2CharMap	synchronize(Short2CharMap m, Object sync) Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.
static Short2CharMap	unmodifiable(Short2CharMap m) Returns an unmodifiable type-specific map backed by the given type-specific map.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MAP

public static final Short2CharMaps.EmptyMap EMPTY_MAP

An empty type-specific map (immutable). It is serializable and cloneable.

Method Detail

fastIterator

public static ObjectIterator<Short2CharMap.Entry> fastIterator(Short2CharMap map)

Returns an iterator that will be fast, if possible, on the entry set of the provided 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 void fastForEach(Short2CharMap map,
                               Consumer<? super Short2CharMap.Entry> consumer)

Iterates quickly, if possible, on the entry set of the provided map.

Parameters:

map - a map on which we will try to iterate quickly.

consumer - the consumer that will be passed to Short2CharMap.FastEntrySet.fastForEach(Consumer), if possible, or to Iterable.forEach(Consumer).

Since:

8.1.0

fastIterable

public static ObjectIterable<Short2CharMap.Entry> fastIterable(Short2CharMap map)

Returns an iterable yielding an iterator that will be fast, if possible, on the entry set of the provided map.

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

singleton

public static Short2CharMap singleton(short key,
                                      char 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 Short2CharMap singleton(Short key,
                                      Character 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 Short2CharMap synchronize(Short2CharMap 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 Short2CharMap synchronize(Short2CharMap 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 Short2CharMap unmodifiable(Short2CharMap 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)