it.unimi.dsi.fastutil.shorts
Class Short2ByteSortedMaps

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.Short2ByteSortedMaps

public class Short2ByteSortedMaps
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
static class Short2ByteSortedMaps.EmptySortedMap
          An immutable class representing an empty type-specific sorted map.
static class Short2ByteSortedMaps.Singleton
          An immutable class representing a type-specific singleton sorted map.
static class Short2ByteSortedMaps.SynchronizedSortedMap
          A synchronized wrapper class for sorted maps.
static class Short2ByteSortedMaps.UnmodifiableSortedMap
          An unmodifiable wrapper class for sorted maps.
 
Field Summary
static Short2ByteSortedMaps.EmptySortedMap EMPTY_MAP
          An empty type-specific sorted map (immutable).
 
Method Summary
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 Short2ByteSortedMap singleton(short key, byte value)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Short2ByteSortedMap singleton(java.lang.Short key, java.lang.Byte value)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Short2ByteSortedMap singleton(short key, byte value, ShortComparator comparator)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Short2ByteSortedMap singleton(java.lang.Short key, java.lang.Byte value, ShortComparator comparator)
          RETURNS a type-specific immutable sorted map containing only the specified pair.
static Short2ByteSortedMap synchronize(Short2ByteSortedMap m)
          Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
static Short2ByteSortedMap synchronize(Short2ByteSortedMap 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 Short2ByteSortedMap unmodifiable(Short2ByteSortedMap 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 Short2ByteSortedMaps.EmptySortedMap EMPTY_MAP
An empty type-specific sorted map (immutable). It is serializable and cloneable.

Method Detail

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.

singleton

public static Short2ByteSortedMap singleton(java.lang.Short key,
                                            java.lang.Byte 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 Short2ByteSortedMap singleton(java.lang.Short key,
                                            java.lang.Byte 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 Short2ByteSortedMap singleton(short key,
                                            byte 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 Short2ByteSortedMap singleton(short key,
                                            byte 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 Short2ByteSortedMap synchronize(Short2ByteSortedMap 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 Short2ByteSortedMap synchronize(Short2ByteSortedMap 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 Short2ByteSortedMap unmodifiable(Short2ByteSortedMap 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)