Package it.unimi.dsi.fastutil.objects

Class Object2ReferenceSortedMaps

java.lang.Object

it.unimi.dsi.fastutil.objects.Object2ReferenceSortedMaps

public final class Object2ReferenceSortedMaps
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	Object2ReferenceSortedMaps.EmptySortedMap<K,V>	An immutable class representing an empty type-specific sorted map.
static class	Object2ReferenceSortedMaps.Singleton<K,V>	An immutable class representing a type-specific singleton sorted map.
static class	Object2ReferenceSortedMaps.SynchronizedSortedMap<K,V>	A synchronized wrapper class for sorted maps.
static class	Object2ReferenceSortedMaps.UnmodifiableSortedMap<K,V>	An unmodifiable wrapper class for sorted maps.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static <K,V> Object2ReferenceSortedMap<K,V>	emptyMap()	Returns an empty sorted map (immutable).
static <K> java.util.Comparator<? super java.util.Map.Entry<K,?>>	entryComparator(java.util.Comparator<? super K> comparator)	Returns a comparator for entries based on a given comparator on keys.
static <K,V> ObjectBidirectionalIterable<Object2ReferenceMap.Entry<K,V>>	fastIterable(Object2ReferenceSortedMap<K,V> map)	Returns an iterable yielding a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
static <K,V> ObjectBidirectionalIterator<Object2ReferenceMap.Entry<K,V>>	fastIterator(Object2ReferenceSortedMap<K,V> map)	Returns a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
static <K,V> Object2ReferenceSortedMap<K,V>	singleton(K key, V value)	Returns a type-specific immutable sorted map containing only the specified pair.
static <K,V> Object2ReferenceSortedMap<K,V>	singleton(K key, V value, java.util.Comparator<? super K> comparator)	RETURNS a type-specific immutable sorted map containing only the specified pair.
static <K,V> Object2ReferenceSortedMap<K,V>	synchronize(Object2ReferenceSortedMap<K,V> m)	Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
static <K,V> Object2ReferenceSortedMap<K,V>	synchronize(Object2ReferenceSortedMap<K,V> 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 <K,V> Object2ReferenceSortedMap<K,V>	unmodifiable(Object2ReferenceSortedMap<K,V> 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 Detail

EMPTY_MAP

public static final Object2ReferenceSortedMaps.EmptySortedMap EMPTY_MAP

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

Method Detail

entryComparator

public static <K> java.util.Comparator<? super java.util.Map.Entry<K,?>> entryComparator(java.util.Comparator<? super K> 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 <K,V> ObjectBidirectionalIterator<Object2ReferenceMap.Entry<K,V>> fastIterator(Object2ReferenceSortedMap<K,V> 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 <K,V> ObjectBidirectionalIterable<Object2ReferenceMap.Entry<K,V>> fastIterable(Object2ReferenceSortedMap<K,V> 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

emptyMap

public static <K,V> Object2ReferenceSortedMap<K,V> emptyMap()

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

This method provides a typesafe access to EMPTY_MAP.

Returns:

an empty sorted map (immutable).

singleton

public static <K,V> Object2ReferenceSortedMap<K,V> singleton(K key,
                                                             V 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 <K,V> Object2ReferenceSortedMap<K,V> singleton(K key,
                                                             V value,
                                                             java.util.Comparator<? super K> 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 <K,V> Object2ReferenceSortedMap<K,V> synchronize(Object2ReferenceSortedMap<K,V> 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 <K,V> Object2ReferenceSortedMap<K,V> synchronize(Object2ReferenceSortedMap<K,V> 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 <K,V> Object2ReferenceSortedMap<K,V> unmodifiable(Object2ReferenceSortedMap<K,V> 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)