Package it.unimi.dsi.fastutil.shorts

Class Short2CharSortedMaps

java.lang.Object

it.unimi.dsi.fastutil.shorts.Short2CharSortedMaps

public final class Short2CharSortedMaps
extends java.lang.Object

A class providing static methods and objects that do useful things with type-specific sorted maps.

See Also:

Collections

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Short2CharSortedMaps.EmptySortedMap	An immutable class representing an empty type-specific sorted map.
static class	Short2CharSortedMaps.Singleton	An immutable class representing a type-specific singleton sorted map.
static class	Short2CharSortedMaps.SynchronizedSortedMap	A synchronized wrapper class for sorted maps.
static class	Short2CharSortedMaps.UnmodifiableSortedMap	An unmodifiable wrapper class for sorted maps.

Field Summary

Fields

Modifier and Type	Field	Description
static Short2CharSortedMaps.EmptySortedMap	EMPTY_MAP	An empty sorted map (immutable).

Method Summary

Modifier and Type	Method	Description
static java.util.Comparator<? super java.util.Map.Entry<java.lang.Short,?>>	entryComparator(ShortComparator comparator)	Returns a comparator for entries based on a given comparator on keys.
static ObjectBidirectionalIterable<Short2CharMap.Entry>	fastIterable(Short2CharSortedMap map)	Returns an iterable yielding a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
static ObjectBidirectionalIterator<Short2CharMap.Entry>	fastIterator(Short2CharSortedMap map)	Returns a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
static Short2CharSortedMap	singleton(short key, char value)	Returns a type-specific immutable sorted map containing only the specified pair.
static Short2CharSortedMap	singleton(short key, char value, ShortComparator comparator)	Returns a type-specific immutable sorted map containing only the specified pair.
static Short2CharSortedMap	singleton(java.lang.Short key, java.lang.Character value)	Returns a type-specific immutable sorted map containing only the specified pair.
static Short2CharSortedMap	singleton(java.lang.Short key, java.lang.Character value, ShortComparator comparator)	RETURNS a type-specific immutable sorted map containing only the specified pair.
static Short2CharSortedMap	synchronize(Short2CharSortedMap m)	Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
static Short2CharSortedMap	synchronize(Short2CharSortedMap m, java.lang.Object sync)	Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.
static Short2CharSortedMap	unmodifiable(Short2CharSortedMap m)	Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_MAP

public static final Short2CharSortedMaps.EmptySortedMap EMPTY_MAP

An empty sorted map (immutable). It is serializable and cloneable.

Method Details

entryComparator

public static java.util.Comparator<? super java.util.Map.Entry<java.lang.Short,?>> entryComparator(ShortComparator comparator)

Returns a comparator for entries based on a given comparator on keys.

Parameters:

comparator - a comparator on keys.

Returns:

the associated comparator on entries.

fastIterator

public static ObjectBidirectionalIterator<Short2CharMap.Entry> fastIterator(Short2CharSortedMap map)

Returns a bidirectional 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) bidirectional iterator on the entry set.

Returns:

a bidirectional iterator on the entry set of the given map that will be fast, if possible.

Since:

8.0.0

fastIterable

public static ObjectBidirectionalIterable<Short2CharMap.Entry> fastIterable(Short2CharSortedMap map)

Returns an iterable yielding a bidirectional 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) bidirectional iterator on the entry set.

Returns:

an iterable yielding a bidirectional iterator on the entry set of the given map that will be fast, if possible.

Since:

8.0.0

singleton

public static Short2CharSortedMap singleton(java.lang.Short key,
java.lang.Character value)

Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.

value - the only value of the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Short2CharSortedMap singleton(java.lang.Short key,
java.lang.Character value,
ShortComparator comparator)

RETURNS a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.

value - the only value of the returned sorted map.

comparator - the comparator to use in the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Short2CharSortedMap singleton(short key,
char value)

Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.

value - the only value of the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Short2CharSortedMap singleton(short key,
char value,
ShortComparator comparator)

Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.

value - the only value of the returned sorted map.

comparator - the comparator to use in the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

synchronize

public static Short2CharSortedMap synchronize(Short2CharSortedMap m)

Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.

Parameters:

m - the sorted map to be wrapped in a synchronized sorted map.

Returns:

a synchronized view of the specified sorted map.

See Also:

Collections.synchronizedSortedMap(SortedMap)

synchronize

public static Short2CharSortedMap synchronize(Short2CharSortedMap m,
java.lang.Object sync)

Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.

Parameters:

m - the sorted map to be wrapped in a synchronized sorted map.

sync - an object that will be used to synchronize the access to the sorted sorted map.

Returns:

a synchronized view of the specified sorted map.

See Also:

Collections.synchronizedSortedMap(SortedMap)

unmodifiable

public static Short2CharSortedMap unmodifiable(Short2CharSortedMap m)

Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.

Parameters:

m - the sorted map to be wrapped in an unmodifiable sorted map.

Returns:

an unmodifiable view of the specified sorted map.

See Also:

Collections.unmodifiableSortedMap(SortedMap)